diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f4f48dfb9..89de1b2e22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,7 @@ GitHub pull requests. Those guidelines are the same as the - [How to Contribute](#how-to-contribute) - [Certificate of Origin](#certificate-of-origin) + - [Git commit Sign-off](#git-commit-sign-off) - [Finding Things That Need Help](#finding-things-that-need-help) - [Versioning](#versioning) - [Codebase and Go Modules](#codebase-and-go-modules) @@ -35,6 +36,25 @@ By contributing to this project you agree to the Developer Certificate of Origin statement that you, as a contributor, have the legal right to make the contribution. See the [DCO](DCO) file for details. +### Git commit Sign-off + +Commit message should contain signed off section with full name and email. For example: + + ```text + Signed-off-by: John Doe + ``` + +When making commits, include the `-s` flag and `Signed-off-by` section will be automatically +added to your commit message. If you want GPG signing too, add the `-S` flag alongside `-s`. + +```bash + # Signing off commit + git commit -s + + # Signing off commit and also additional signing with GPG + git commit -s -S +``` + ## Finding Things That Need Help If you're new to the project and want to help, but don't know where to start, we