diff options
| author | James Muir <james@openssl.org> | 2023-11-20 13:14:12 -0500 |
|---|---|---|
| committer | Hugo Landau <hlandau@openssl.org> | 2023-11-23 15:13:22 +0000 |
| commit | f831adc00add9e37d730e587f86a0d656b051286 (patch) | |
| tree | 3c2ee3b1f2129080ab9ed0f043ff4f6913fe1eb2 | |
| parent | baa714423f9cf331bd426793c5bdef52c35d0f43 (diff) | |
contributing-doc: give example commit message with "CLA: trivial"
The text "CLA: trivial" should go at the bottom of the commit message.
Also, update the force-push command to include the repository and
branch, which can avoid unexpected force-push results.
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22775)
(cherry picked from commit cad48c5b0f7180c5fab8db70feb07e0846d80d67)
| -rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13a5d63695..0117fce16f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,9 +22,20 @@ guidelines: 1. Anything other than a trivial contribution requires a [Contributor License Agreement] (CLA), giving us permission to use your code. If your contribution is too small to require a CLA (e.g. fixing a spelling - mistake), place the text "`CLA: trivial`" on a line by itself separated by - an empty line from the rest of the commit message. It is not sufficient to - only place the text in the GitHub pull request description. + mistake), then place the text "`CLA: trivial`" on a line by itself below + the rest of your commit message separated by an empty line, like this: + + ``` + One-line summary of trivial change + + Optional main body of commit message. It might contain a sentence + or two explaining the trivial change. + + CLA: trivial + ``` + + It is not sufficient to only place the text "`CLA: trivial`" in the GitHub + pull request description. [Contributor License Agreement]: <https://www.openssl.org/policies/cla.html> @@ -32,8 +43,8 @@ guidelines: ``` git commit --amend - [add the line, save and quit the editor] - git push -f + # add the line, save and quit the editor + git push -f [<repository> [<branch>]] ``` 2. All source files should start with the following text (with |