Any kind of contribution is welcome as a pull request. If you are unsure on how to fork a repository and then create a pull request from your fork, please read this blog post for a quick guide.
You can pick any issue from the issue tracker. We try to document all feature ideas, tasks and bugs as issues in the tracker. Issues marked with the tag "up-for-grabs" are preferred to be added in the next version, and therefore are higher prioritized. You might want to start with one of those tasks. You can just as well pick any other task, though. If you have any questions, get in touch. Code and Documentation should be in english.
If you have an idea, submit it to the issue tracker for discussion. We will let you know our thoughts. If you want to develop your idea yourself, you can do so and submit a pull request. Please mark your new task with the "idea" tag.
Please keep documentation up-to-date when changing the code. Documentation is made up of the following elements:
- README.md file
- Javadoc: please provide sensible javadoc of at least public API
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 🚀
:rocket:when adding a feature - 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 📝
:memo:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🚀