Minerware is an open source project, and contributions from the community are welcomed, as long as they comply with our quality standards and licensing.
Code contributions must be submitted using GitHub Pull Requests, where they will be reviewed by maintainers.
The basic procedure to create a pull request is:
- Fork the repository on GitHub. This gives you your own copy of the repository to make changes to.
- Create a branch on your fork for your changes.
- Make the changes you want to make on this branch.
- You can then make a pull request to the project.
Pull requests will be reviewed by maintainers when they are available. Note that there might be a long wait time before a reviewer looks at your PR.
Depending on the changes, maintainers might ask you to make changes to the PR to fix problems or to improve the code. Do not delete your fork while your pull request remains open, otherwise you won't be able to make any requested changes and the PR will end up being declined.
The following are required as a minimum for pull requests. PRs that don't meet these requirements will be declined unless updated to meet them.
Minerware is licensed under GPLv3 license. By proposing a pull request, you agree to your code being distributed within Minerware under the same license. If you take code from other projects, that code MUST be licensed under an GPL-compatible license.
If you want to make multiple changes, those changes should each be contributed as separate pull requests. DO NOT mix unrelated changes.
Do not include changes which aren't strictly necessary. This makes it harder to review a PR, because the code diff becomes larger and harder to review. This means:
- don't reformat or rearrange existing code
- don't change things that aren't related to the PR's objective
- don't rewrite existing code just to make it "look nicer"
- don't change PhpDocs to native types in code you didn't write
To change or add new translations you will need to create a PR as mentioned above.