003-git-etiquette
process
accepted
Git Etiquette
Motivation
In a large project with multiple contributors, it is necessary to establish some git etiquette to keep the project maintainable. The following are the guiding principles:
- make git history more readable
- allow automatic changelog generation
- promote self-contained PRs that are easier to review
- promote continuous integration
Decision
Contributors will follow these git practices to keep the project maintainable.
- apply changes via PRs
- use conventional commits for git messages
- all commits must be gpg-signed and signed-off, acting as a Developer Certificate of Origin (DCO):
Developer Certificate of OriginVersion 1.1Copyright (C) 2004, 2006 The Linux Foundation and its contributors.Everyone is permitted to copy and distribute verbatim copies of thislicense document, but changing it is not allowed.Developer's Certificate of Origin 1.1By making a contribution to this project, I certify that:(a) The contribution was created in whole or in part by me and Ihave the right to submit it under the open source licenseindicated in the file; or(b) The contribution is based upon previous work that, to the bestof my knowledge, is covered under an appropriate open sourcelicense and I have the right under that license to submit thatwork with modifications, whether created in whole or in partby me, under the same open source license (unless I ampermitted to submit under a different license), as indicatedin the file; or(c) The contribution was provided directly to me by some otherperson who certified (a), (b) or (c) and I have not modifiedit.(d) I understand and agree that this project and the contributionare public and that a record of the contribution (including allpersonal information I submit with it, including my sign-off) ismaintained indefinitely and may be redistributed consistent withthis project or the open source license(s) involved.