2.1 KiB
If you wish to contribute, this is your starting point.
This document contains guidelines to help you make your contribution clear and consistent. These guidelines also help us to review your PR faster and, as a result, will give you appropriate credit in your GitHub profile.
If you have time to contribute to this project, we are happy to give you credit for it.
We thank you in advance for your contribution!
Features
You can request a new feature by submitting an issue. If you would like to implement a new feature, feel free to issue a Pull Request.
Pull requests
Pull Requests (PRs) are awesome. Get familiar with the following guidelines before you begin:
-
Search the project for a Pull Request related to your submission. You don't want to duplicate effort.
-
A PR that contains code changes should be created from a git branch based on develop:
git checkout -b my-fix-branch develop -
Follow our coding style rules.
-
Run full test suite and ensure all tests pass.
- If some tests fail, ensure that you follow coding style rules.
-
One PR - one issue. Refrain from fixing multiple issues in the same pull request. Several small PRs are preferable instead of a big one.
-
If the PR introduces a new feature or fixes an issue, please add the appropriate test case(s).
-
Follow conventional commit guidelines for your commit message(s) when saving changes in your branch and PR.
-
Add your name to the Credits file. We like to give credit where it's due.
-
If we suggest changes:
-
Make the required updates.
-
Re-run test suite to ensure tests are still green.
-
Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
git rebase develop -i git push origin my-fix-branch -f
-
-
After your pull request is merged, you can safely delete your branch.