BukkitLib is opensource, meaning that anyone willing, may modify and share the source. We're always open to suggestions and improvements.
For those who wish to contribute, we encourage you to fork the repository and submit pull requests. Below you will find guidelines that will explain this process in further detail.
- To get started, sign the Contributor License Agreement
- Make sure you have a GitHub account.
- If the issue is a bug, submit a ticket for it.
- Clearly describe the issue including steps to reproduce it.
- Make sure you fill in the version that you know has the issue.
- If an issue already exists, comment on the issue explaining that you'll be working on this particular issue.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work.
- This is usually the master branch.
- For ease of use, we recommend that you work on a branch other than master.
- To quickly create a topic branch based on master;
git checkout -b contribution
- Make changes and commit where necessary.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - If you're working in NetBeans, you can format your code easily by clicking "Source" -> "Format".
- Make sure your commit messages are in line with those which are already made.
- Make sure your commit message closes the previously made issue. See this blog post.
- Make sure your changes compile (and work!).
- Make sure your changes work and compile without difficulty.
- Make sure there are no bugs in your code.
- Make sure your code is written in the K&R Style.
- Do not increment the version number.
- If you want to add multiple changes, please make one pull request per change. This way, it's easier to accept your changes faster and won't block the other changes if there is an issue with a specific line of code.
- Please avoid having to add files in the main namespace where possible.
- Make sure all changes work before you commit these, this avoids having multiple unnecessary commits.
- Please refrain from using an excessive amount of commits. As few as possible is generally the best.
- Please do not spread your addition over several pull-requests.
- Push your changes to a topic branch in your fork of the repository.
- Make sure your commit
- Submit a pull request to this repository.
- Explain in detail what each one of your commits changes and point out any big changes.
- Wait as a developer evaluates your changes.