Contributions to the project are welcome and encouraged to improve the experience for everyone. To avoid confusion and to ensure that the changes are in line with the project's goals, please follow the guidelines below.
If you encounter any issues or bugs while using the project, please report them using the issue tracker. But before you do that, please check if the issue has already been reported by someone else.
When reporting an issue, please include the following information:
- A clear and descriptive title
- A detailed description of the issue
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Screenshots or logs if applicable
Note
The points above are handled by the issue template. Please fill out the template to the best of your ability. If you unsure about something or need help, feel free to use the discussion section.
If you want to contribute to the project by adding new features, fixing bugs, or improving the codebase, you can do it by following these steps:
- Create a fork of the project
- Create a new branch for your changes
- Make your changes
- Write tests for your changes
- Run the tests
- Commit your changes
- Create a pull request
Note
We know that writing tests can be a pain, but they are invaluable in ensuring that your changes work as expected. Without tests, it is difficult to verify that your modifications do not break existing functionality. This becomes especially important when updating the underlying Minecraft version, as such updates can introduce changes that might break the project.