Contributing¶
We'd love for you to contribute to our source code and to make the project even better than it is today! Here are the guidelines we'd like you to follow:
Git Commit Messages¶
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit title -
Consider starting the commit message with an applicable emoji:
:art:when improving the format/structure of the code
:racehorse:when improving performance
:non-potable_water:when plugging memory leaks
: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 lint/checkstyle warnings
Find all the available emojis here.
Got a Question or Problem?¶
If you feel that we're missing an important bit of documentation, feel free to file an issue so we can help. Here's an example to get you started:
What are you trying to do or find out more about?
Where have you looked?
Where did you expect to find this information?
Found an Issue?¶
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our project.
To submit an issue, please check the Issue Template.
Even better you can submit a Pull Request with a fix.
Pull Request¶
To generate a pull request, please consider following Pull Request Template.
- Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
- Please have a look at License before sending pull requests. We cannot accept code without this.
That's it! Thank you for your contribution!