From owner-dev-commits-doc-all@freebsd.org Thu Jul 15 21:09:11 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 37EFE650CD0 for ; Thu, 15 Jul 2021 21:09:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4GQn6v11Hgz4Vg2; Thu, 15 Jul 2021 21:09:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 00B2310CC4; Thu, 15 Jul 2021 21:09:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 16FL9AEv027453; Thu, 15 Jul 2021 21:09:10 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 16FL9Ah5027452; Thu, 15 Jul 2021 21:09:10 GMT (envelope-from git) Date: Thu, 15 Jul 2021 21:09:10 GMT Message-Id: <202107152109.16FL9Ah5027452@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Kevin Bowling Subject: git: 274b93aba7 - main - comitters-guide: clarify submitted and approved post git MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: kbowling X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 274b93aba7f1c27531b5cf4ed5b59bd214087c74 Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 15 Jul 2021 21:09:11 -0000 The branch main has been updated by kbowling (ports committer): URL: https://cgit.FreeBSD.org/doc/commit/?id=274b93aba7f1c27531b5cf4ed5b59bd214087c74 commit 274b93aba7f1c27531b5cf4ed5b59bd214087c74 Author: Kevin Bowling AuthorDate: 2021-07-15 21:07:50 +0000 Commit: Kevin Bowling 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 (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)