Skip to content

Commit 5093597

Browse files
committedJun 12, 2020
top: Update contribution and commit guide to include optional sign-off.
MicroPython already requires contributors to implicitly sign-off on a set of points, which are listed in CODECONVENTIONS.md. This commit adjusts this wording to allow explicit sign-off using the git "Signed-off-by:" feature. There is no reference made to https://developercertificate.org/ because the project already has its own version of this. Signed-off-by: Damien George <damien@micropython.org>
1 parent 2b99003 commit 5093597

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed
 

‎CODECONVENTIONS.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@ change beyond 5 lines would likely require such detailed description.
2727
To get good practical examples of good commits and their messages, browse
2828
the `git log` of the project.
2929

30-
MicroPython doesn't require explicit sign-off for patches ("Signed-off-by"
31-
lines and similar). Instead, the commit message, and your name and email
32-
address on it construes your sign-off of the following:
30+
When committing you are encouraged to sign-off your commit by adding
31+
"Signed-off-by" lines and similar, eg using "git commit -s". If you don't
32+
explicitly sign-off in this way then the commit message, which includes your
33+
name and email address in the "Author" line, implies your sign-off. In either
34+
case, of explicit or implicit sign-off, you are certifying and signing off
35+
against the following:
3336

3437
* That you wrote the change yourself, or took it from a project with
3538
a compatible license (in the latter case the commit message, and possibly
@@ -43,8 +46,11 @@ address on it construes your sign-off of the following:
4346
copyright for your changes (for smaller changes, the commit message
4447
conveys your copyright; if you make significant changes to a particular
4548
source module, you're welcome to add your name to the file header).
46-
* Your signature for all of the above, which is the 'Author' line in
47-
the commit message, and which should include your full real name and
49+
* Your contribution including commit message will be publicly and
50+
indefinitely available for anyone to access, including redistribution
51+
under the terms of the project's license.
52+
* Your signature for all of the above, which is the "Signed-off-by" line
53+
or the "Author" line in the commit message, includes your full real name and
4854
a valid and active email address by which you can be contacted in the
4955
foreseeable future.
5056

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ make sure that you are acquainted with Contributor Guidelines:
33

44
https://github.com/micropython/micropython/wiki/ContributorGuidelines
55

6-
and Code Conventions:
6+
as well as the Code Conventions, which includes details of how to commit:
77

88
https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md

0 commit comments

Comments
 (0)
Please sign in to comment.