root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity

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)
This commit is contained in:
James Muir 2023-11-20 13:14:12 -05:00 committed by Hugo Landau
parent df5e72d220
commit cad48c5b0f
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -22,9 +22,20 @@ guidelines:
1. Anything other than a trivial contribution requires a [Contributor 1. Anything other than a trivial contribution requires a [Contributor
License Agreement] (CLA), giving us permission to use your code. 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 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 mistake), then place the text "`CLA: trivial`" on a line by itself below
an empty line from the rest of the commit message. It is not sufficient to the rest of your commit message separated by an empty line, like this:
only place the text in the GitHub pull request description.
```
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> [Contributor License Agreement]: <https://www.openssl.org/policies/cla.html>
@ -32,8 +43,8 @@ guidelines:
``` ```
git commit --amend git commit --amend
[add the line, save and quit the editor] # add the line, save and quit the editor
git push -f git push -f [<repository> [<branch>]]
``` ```
2. All source files should start with the following text (with 2. All source files should start with the following text (with