All changes will need to:
- build successfully with
docker build .
, - be signed-off,
- have good commit messages.
Additionally changes that are not backwards-compatible (for example changing or removing API) need to first be discussed using issues.
docker build .
will perform all necessary checks including lints and
integration tests
The sign-off is a simple line at the end of the git commit message,
which certifies that you wrote it or otherwise have the right to pass it
on as a open-source patch.
The rules are pretty simple: if you can certify the below:
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 saying
Signed-off-by: Random J Developer <random@developer.example.org>
using 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 –signoff=.
To sign-off your last commit:
git commit --amend --signoffCommit messages should be self-contained and describe the motivation for a change. The subject line should be short, with any elaborations in the body. If the commit closes an issue, write
Closes #issuenumber
at the
end of the body.
Keep in mind the seven rules of a great Git commit message:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how