Contributions are always welcome!
Your contributions will have the best chance of being addressed and accepted smoothly if you understand and follow the guidelines.
Any suggestions or bug reports should start with issue for tracking and discussion. Report any bugs as soon as possible.
Features or changes should have discussion before work starts, so maintainers can be sure they fit in this repo.
Versioning should follow Semantic Versioning.
All commit messages should follow Conventional Commits.
Each pull request should address a single overall feature or bug if possible. If the change requires documentation updates those should be in the SAME pull request. This makes reviews easier, rollbacks manageable, and the history clearer.
Merges will be done as "Squash and Merge" in most cases, so do not worry about having multiple commits.
Try to follow the existing formats of files you modify.
- Clarity over brevity.
- Less than 80 columns whenever reasonable.
The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Then you just add a line to every git commit message:
Signed-off-by: Joe Smith <[email protected]>
Use your real name (sorry, no pseudonyms or anonymous contributions.)
If you set your user.name and user.email git configs, you can sign your
commit automatically with git commit -s.