git: 274b93aba7 - main - comitters-guide: clarify submitted and approved post git

[Kevin Bowling]

The branch main has been updated by kbowling (ports committer):

URL: https://cgit.FreeBSD.org/doc/commit/?id=274b93aba7f1c27531b5cf4ed5b59bd214087c74

commit 274b93aba7f1c27531b5cf4ed5b59bd214087c74
Author:     Kevin Bowling <kbowling at FreeBSD.org>
AuthorDate: 2021-07-15 21:07:50 +0000
Commit:     Kevin Bowling <kbowling at FreeBSD.org>
CommitDate: 2021-07-15 21:08:27 +0000

    comitters-guide: clarify submitted and approved post git
    
    Reviewed by: imp
    Differential Revision: https://reviews.freebsd.org/D30969
---
 .../en/articles/committers-guide/_index.adoc       | 23 +++++++++++++---------
 1 file changed, 14 insertions(+), 9 deletions(-)

diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index 6c72d36eac..f3e5718ec1 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2803,17 +2803,22 @@ Typically used when there is no PR, for example if the issue was reported on
 a mailing list.
 
 |`Submitted by:`
-|The name and e-mail address of the person that submitted the fix; for developers, just the username on the FreeBSD cluster.
+|This has been deprecated with git; submitted patches should have the author set by using `git commit --author` with a full name and valid email.
 
-Typically not used with Git; submitted patches should
-have the author set by using `git commit --author`.
-
-If the submitter is the maintainer of the port being committed, include "(maintainer)" after the email address.
+|`Reviewed by:`
+|The name and e-mail address of the person or people that reviewed the change; for developers, just the username on the FreeBSD cluster. If a patch was submitted to a mailing list for review, and the review was favorable, then just include the list name. If the reviewer is not a member of the project, provide the name, email, and if ports an external role like maintainer:
+a|
 
-Avoid obfuscating the email address of the submitter as this adds additional work when searching logs.
+Reviewed by a developer:
+[source,shell]
+....
+Reviewed by: username
 
-|`Reviewed by:`
-|The name and e-mail address of the person or people that reviewed the change; for developers, just the username on the FreeBSD cluster. If a patch was submitted to a mailing list for review, and the review was favorable, then just include the list name.
+Reviewed by a ports maintainer that is not a developer:
+[source,shell]
+....
+Reviewed by: Full Name <valid at email> (maintainer)
+....
 
 |`Tested by:`
 |The name and e-mail address of the person or people that tested the change; for developers, just the username on the FreeBSD cluster.
@@ -2826,7 +2831,7 @@ The name and e-mail address of the person or people that approved the change; fo
 There are several cases where approval is customary:
 
 * while a new committer is under mentorship
-* commits to an area of the tree to which you do not usually commit
+* commits to an area of the tree covered by the LOCKS file (src)
 * during a release cycle
 * committing to a repo where you do not hold a commit bit (e.g. src committer committing to docs)