git: b7385189ef - main - committers-guide: Strongly suggest careful review of all pull requests

Warner Losh <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by imp:

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

commit b7385189ef01de0a37ad5490ce14f3c85bab1af2
Author:     Warner Losh <[email protected]>
AuthorDate: 2021-06-16 22:33:08 +0000
Commit:     Warner Losh <[email protected]>
CommitDate: 2021-06-17 16:38:19 +0000

    committers-guide: Strongly suggest careful review of all pull requests
    
    Pull requests should be treated with extreme caution and be carefully
    reviewed. Add this advice.
    
    Reviewed by:            allanjude,bcr
    Sponsored by:           Netflix
    Differential Revsion:   https://reviews.freebsd.org/D30794
---
 documentation/content/en/articles/committers-guide/_index.adoc | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index fffc6ef128..1d1d3df923 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2329,15 +2329,21 @@ However, when there's multiple commits, especially when minor adjustments are ne
 Briefly, these commands create a branch; cherry-picks the changes from the pull request; tests it; adjusts the commit messages; and fast forward merges it back to `main`.
 The PR number is `$PR` below.
 When adjusting the message, add `Pull Request: https://github.com/freebsd-src/pull/$PR`.
+All pull requests committed to the FreeBSD repository should be reviewed by at least one person.
+This need not be the person committing it, but in that case the person committing it should trust the other reviewers competence to review the commit.
+Committers that do a code review of pull requests before pushing them into the repo should add a `Reviewed by:` line to the commit, because in this case it is not implicit.
+Add anybody that reviews and approves the commit on github to `Reviewed by:` as well.
+As always, care should be taken to ensure the change does what it is supposed to, and that no malicious code is present.
 [NOTE]
 ======
 In addition, please check to make sure that the pull request author name is not anonymous.
-Github's web interface generates names like:
+Github's web editing interface generates names like:
 [source,shell]
 ....
 Author:     github-user <[email protected]>
 ....
 A polite request to the author for a better name and/or email should be made.
+Extra care should be taken to ensure no style issue or malicious code is introduced.
 ======
 
 [source,shell]
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/dev-commits-doc-all
To unsubscribe, send any mail to "[email protected]"
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.