Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
180 lines (124 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

180 lines (124 loc) · 4.35 KB

Contributing to UltraFastPregen

⚠️ Important Notice - Proprietary Software

UltraFastPregen is proprietary software (All Rights Reserved).

Unlike open-source projects, contributions are handled differently due to copyright protection.

📋 How to Contribute

✅ You CAN:

  1. Report Bugs

    • Open an issue on GitHub
    • Provide detailed reproduction steps
    • Include server version, Java version, logs

  2. Suggest Features

    • Open a feature request issue
    • Explain the use case
    • Describe expected behavior

  3. Help with Documentation

    • Fix typos in README
    • Improve explanations
    • Translate documentation

  4. Test Beta Versions

    • Test new releases
    • Report performance metrics
    • Provide feedback

❌ You CANNOT:

  • ❌ Submit code changes (Pull Requests)
  • ❌ Fork and modify the repository
  • ❌ Create derivative works
  • ❌ Redistribute modified versions

🐛 Reporting Bugs

Before creating a bug report, please check existing issues.

When you create a bug report, include:

Required Information:

  • Plugin Version: (e.g., 1.0.0)
  • Paper Version: (e.g., 1.21.11)
  • Java Version: (e.g., Java 21)
  • RAM Allocated: (e.g., 8GB)
  • Other Plugins: List installed plugins

Reproduction Steps:

  1. What command did you run?
  2. What happened?
  3. What did you expect to happen?
  4. Can you reproduce it consistently?

Logs:

  • Include relevant console output
  • Include the full error message
  • Include /pregen status output if relevant

Example Bug Report:

**Plugin Version**: 1.0.0
**Paper**: 1.21.11
**Java**: 21

**Steps to Reproduce**:
1. Run `/pregen start 10000`
2. Server freezes after 50% progress

**Expected**: Continue until 100%
**Actual**: Freezes at 50%

**Logs**: [paste logs here]

✨ Suggesting Enhancements

Feature requests are welcome! When suggesting:

Good Feature Request:

  • Clear title: "Add option to skip ocean chunks"
  • Problem: "Generating ocean chunks is slow and useless"
  • Solution: "Add config option: skip-oceans: true"
  • Use case: "Saves 30% time on islands maps"
  • Examples: "Like Chunky's ocean skip feature"

What We Look For:

  • ✅ Useful for many users
  • ✅ Doesn't break existing functionality
  • ✅ Fits the plugin's scope
  • ✅ Technically feasible

📝 Documentation Improvements

You CAN help with documentation by:

  1. Reporting typos/errors in README, guides, etc.
  2. Suggesting clearer explanations
  3. Providing better examples
  4. Translating to other languages

Open an issue with:

  • File name
  • Current text
  • Suggested improvement

🧪 Beta Testing

Help test new versions:

  1. Download beta releases
  2. Test on your server
  3. Report performance metrics
  4. Report any bugs

Beta testers get:

  • ✅ Early access to new features
  • ✅ Credit in changelog
  • ✅ Direct feedback channel

⚖️ Copyright Assignment

Important: Any contribution you make (bug reports, suggestions, documentation) may be used by the author without restriction.

By contributing, you agree that:

  • Your contributions can be integrated into the plugin
  • The author retains all copyright
  • No compensation is owed for contributions
  • Your name may be credited in the changelog (optional)

💡 Why This Approach?

UltraFastPregen uses "All Rights Reserved" to:

  • 🛡️ Prevent unauthorized modifications
  • 🛡️ Prevent unauthorized commercial use
  • 🛡️ Maintain code quality and integrity
  • 🛡️ Protect the plugin's performance advantage

This doesn't mean the community can't help - it just means contributions are handled through issues and suggestions rather than code submissions.

📞 Contact

For questions about contributing:

For commercial inquiries or special requests:

  • Contact the author directly

🙏 Thank You!

Your bug reports, feature suggestions, and feedback are highly valued and help make UltraFastPregen better for everyone!

Even though you can't submit code directly, your contributions make a real difference.

Note: If you're interested in contributing code professionally, commercial licensing may include development partnerships. Contact the author for details.