git: e93b38d423 - main - committers-guide: Document "Pull Request:" lines
Warner Losh
imp at FreeBSD.org
Wed Jun 30 19:38:43 UTC 2021
The branch main has been updated by imp:
URL: https://cgit.FreeBSD.org/doc/commit/?id=e93b38d4232b1600c17b363478a63479d8ae5b52
commit e93b38d4232b1600c17b363478a63479d8ae5b52
Author: Warner Losh <imp at FreeBSD.org>
AuthorDate: 2021-06-30 19:33:39 +0000
Commit: Warner Losh <imp at FreeBSD.org>
CommitDate: 2021-06-30 19:36:51 +0000
committers-guide: Document "Pull Request:" lines
A number of committers have started using "Pull Request:" to document
when a change was submitted by a pull request to give context discussed
there should it be necessary in the future. I documented it previously
in the `Landing a github pull request` section by implication as well.
Sponsored by: Netflix
---
documentation/content/en/articles/committers-guide/_index.adoc | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index d253bd9a50..6c72d36eac 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2874,6 +2874,11 @@ Approved by: re (username)
|`Sponsored by:`
|Sponsoring organizations for this change, if any. Separate multiple organizations with commas. If only a portion of the work was sponsored, or different amounts of sponsorship were provided to different authors, please give appropriate credit in parentheses after each sponsor name. For example, `Example.com (alice, code refactoring), Wormulon (bob), Momcorp (cindy)` shows that Alice was sponsored by Example.com to do code refactoring, while Wormulon sponsored Bob's work and Momcorp sponsored Cindy's work. Other authors were either not sponsored or chose not to list sponsorship.
+|`Pull Request:`
+|This change was submitted as a pull request or merge request against one of FreeBSD's public read-only Git repositories.
+It should include the entire URL to the pull request, as these often act as code reviews for the code.
+For example: `https://github.com/freebsd/freebsd-src/pull/745`
+
|`Differential Revision:`
|The full URL of the Phabricator review. This line __must be the last line__. For example: `https://reviews.freebsd.org/D1708`.
More information about the dev-commits-doc-all
mailing list