Bug 259385

Summary: Committers Guide: "Approved by" description missed the case where committer != maintainer
Product: Documentation Reporter: Gerald Pfeifer <gerald>
Component: Books & ArticlesAssignee: Ed Maste <emaste>
Status: Closed FIXED    
Severity: Affects Some People CC: doc, emaste
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   

Description Gerald Pfeifer freebsd_committer freebsd_triage 2021-10-23 17:35:20 UTC
https://docs.freebsd.org/en/articles/committers-guide/#commit-log-message
is pretty nice.

Just one aspect that is missing is the case for Approved by when the
committer is not the maintainer of a port in question.

This is the case when the maintainer is not a committer (and a committer
pushes on their behalf) or when a committer does work on a port maintained
by another committer.
Comment 1 Ed Maste freebsd_committer freebsd_triage 2023-06-20 18:26:55 UTC
Like this?

diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index 612db2afb0..898fa7e307 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2515,6 +2515,7 @@ There are several cases where approval is customary:
 * 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)
+* committing to a port maintained by someone else
 
 While under mentorship, get mentor approval before the commit. Enter the mentor's username in this field, and note that they are a mentor:
Comment 2 Graham Perrin freebsd_committer freebsd_triage 2023-06-21 06:08:49 UTC
^Triage: make the former assignee a cc recipient.
Comment 3 Gerald Pfeifer freebsd_committer freebsd_triage 2023-06-21 21:00:08 UTC
(In reply to Ed Maste from comment #1)
> Like this?

Yes. Thank you, Ed!
Comment 4 commit-hook freebsd_committer freebsd_triage 2023-06-21 21:05:22 UTC
A commit in branch main references this bug:

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

commit fc27e71592205c8bb74ded42c20d17718fef4a05
Author:     Ed Maste <emaste@FreeBSD.org>
AuthorDate: 2023-06-20 18:27:07 +0000
Commit:     Ed Maste <emaste@FreeBSD.org>
CommitDate: 2023-06-21 21:04:26 +0000

    Committer's guide: add an "Approved by" case used in ports

    PR:             259385
    Reviewed by:    gerald
    Sponsored by:   The FreeBSD Foundation

 documentation/content/en/articles/committers-guide/_index.adoc | 1 +
 1 file changed, 1 insertion(+)