Slaan oor na inhoud

🐉 Contributing to DragonMineZ

Thank you for your interest in contributing to DragonMineZ! Whether you want to report a bug, improve documentation, propose features, or help with development, we’re excited to collaborate with you. If you want to donate to the project, you can jump to the Patreon section.

Please follow the guidelines below to ensure a smooth process for all contributors.

Getting Started

  1. Read the Code of Conduct

  2. By contributing, you agree to uphold the Code of Conduct.

  3. Check Existing Issues

  4. Look through the Issues to see if someone has already reported your concern or proposed your idea.

  5. Fork the Repository

  6. Clone your fork to your local environment for testing and development:

git clone https://github.com/your-username/DragonMineZ.git
4. Set Up Your EnvironmentEnsure you have the necessary tools installed:

  • Java Development Kit (JDK) version 17+
  • Gradle or Maven for builds
  • Minecraft Forge for modding support

If you are not forking and/or creating an addon, there is no need to follow step 3.

How to Contribute

🐛 Reporting Bugs

If you’ve encountered a bug, please:

  • Open a Bug Report.
  • Include as much detail as possible:
  • A clear description of the issue
  • Steps to reproduce
  • Expected vs. actual results
  • Screenshots, logs, or crash reports (if applicable)

⭐ Suggesting Features

Have a great idea? Open a Feature Request and provide:

  • A clear and concise explanation of the feature
  • Potential benefits and impact
  • Any alternatives or related concepts
Alternatively, you can suggest features in our Discord server.

⏳ Submitting Pull Requests (PRs)

Step 1: Create a Branch

Use a descriptive branch name:

git checkout -b fix/short-description

Step 2: Make Your Changes

  • Write clean and concise code.
  • Test your changes locally to ensure they work as intended.
  • Follow the project's coding conventions and standards.

Step 3: Commit Your Changes

Write a meaningful commit message:

git commit -m "Fix: Resolved issue with XYZ feature"

Step 4: Push Your Changes

git push origin fix/short-description

Step 5: Open a Pull Request

Go to your fork on GitHub and submit a Pull Request.

  • Describe the changes and link related issues.
  • Be prepared to discuss and revise your code based on feedback.
  • Note: We do manually run GitHub Actions checks on PRs, so ensure your code passes all tests, if these fail, your PR will not be merged.

📚 Contributor Guidelines

  1. Coding Standards

  2. Use descriptive variable and method names.

  3. Format code consistently (e.g., indentations, spacing).
  4. Write comments for complex logic.

  5. Documentation

  6. Update or add documentation for new or modified features.

  7. Ensure the Wiki (TBD) reflects major changes.

  8. Testing

  9. Test thoroughly across relevant scenarios.

  10. Fix any linting or compilation issues before submitting your PR.

💬 Community Communication

  • Join our Discord server (link in the repository’s README) for real-time discussions.

🫴 Supporting the Project on Patreon

DragonMineZ is a community-driven project, and your support helps us keep improving and delivering new features! Consider becoming a patron on Patreon to support the development and maintenance of the mod.

Patrons receive exclusive benefits, such as:

  • Early access to new features
  • Behind-the-scenes updates
  • Recognition in our community

Every contribution, no matter how small, helps us continue improving DragonMineZ. Thank you for your support!

🧾 Licensing

By contributing, you agree that your contributions will be licensed under the same license that governs the project.

🙌 Thank You!

We’re excited to see your contributions and ideas! If you have any questions or need assistance, please reach out to the team.