Thank you for your interest in contributing to Miners Online! We value your input and look forward to collaborating with you to enhance our server and related projects. Please take a moment to review these guidelines before contributing to any of our repositories.
If you encounter any bugs, performance issues, or have feature requests, please report them on our GitHub Issues page. When reporting an issue, please fill out the provide templates.
Issues that do not follow the templates will be rejected.
We encourage the community to discuss new ideas, feature requests, or improvements in our GitHub Discussions forum. This is the best place to brainstorm and refine ideas before implementing them. Be sure to specify which repository or project your idea pertains to.
If you would like to contribute code to one of the Miners Online repositories, follow these steps:
-
Choose the Right Repository: Identify the correct repository within the Miners Online organization for your contribution.
-
Fork the Repository: Start by forking the relevant repository to your GitHub account.
-
Create a Branch: Create a new branch in your forked repository for your changes. Use a descriptive name for the branch, such as
feature/add-new-toolorbugfix/fix-teleport-issue. -
Make Your Changes: Implement your changes, ensuring that your code follows our coding standards (see below).
-
Test Your Changes: Thoroughly test your code in a local environment to ensure it works as expected and does not introduce new issues.
-
Commit and Push: Commit your changes with a clear and concise commit message. Then push the branch to your GitHub fork.
-
Open a Pull Request: Submit a pull request to the original repository in the Miners Online organization from your forked branch. In your pull request, provide a detailed explanation of what your changes do and why they should be merged.
-
Address Feedback: Be prepared to make revisions based on feedback from project maintainers or other contributors.
To maintain code quality and consistency across all repositories, please adhere to the following standards:
- Code Style: Follow consistent naming conventions, indentation, and formatting.
- Commit Style: Follow the Conventional Commits standard. More information on the Conventional Commits Cheatsheet by @qoomon.
- Documentation: Ensure your code is well-documented, especially for complex functions or classes. Use comments where necessary to explain the purpose and logic of your code.
- Performance Considerations: Keep performance in mind. Avoid introducing changes that could negatively impact the server’s performance.
- Modularity: Whenever possible, write modular and reusable code to make it easier for others to build upon your work.
Before submitting a pull request, ensure that:
- All existing tests pass: If the project includes automated tests, run them to verify that your changes don't break existing functionality.
- New features are tested: If you’ve added a new feature, consider writing new tests to cover it.
We strive to maintain a friendly and welcoming community. By participating in this project, you agree to:
- Be respectful and considerate in all your interactions.
- Provide constructive feedback and avoid disparaging remarks.
- Collaborate and share knowledge to help others learn and grow.
If you’re unsure about how to contribute or need help with any part of the process, don’t hesitate to ask. You can reach out through GitHub Discussions or directly contact a project maintainer for guidance.
By contributing to any Miners Online repository, you agree that your contributions will be licensed under the same license as that project.
Thank you again for your interest in contributing to Miners Online. We’re excited to see what we can build together!