[PATCH] D72468: Update the attribution policy to use the 'Author' property of a git commit

[Eric Christopher via llvm-commits]

LGTM and thank you.

On Thu, Jan 9, 2020, 1:32 PM Daniel Sanders via Phabricator <
reviews at reviews.llvm.org> wrote:

> dsanders updated this revision to Diff 237185.
> dsanders marked 2 inline comments as done.
> dsanders added a comment.
>
> Add a bit about asking someone to commit for you so that we can document
> providing the information needed for the Author property
>
>
> Repository:
>   rG LLVM Github Monorepo
>
> CHANGES SINCE LAST ACTION
>   https://reviews.llvm.org/D72468/new/
>
> https://reviews.llvm.org/D72468
>
> Files:
>   llvm/docs/DeveloperPolicy.rst
>
>
> Index: llvm/docs/DeveloperPolicy.rst
> ===================================================================
> --- llvm/docs/DeveloperPolicy.rst
> +++ llvm/docs/DeveloperPolicy.rst
> @@ -292,8 +292,15 @@
>
>  Below are some guidelines about the format of the message itself:
>
> -* Separate the commit message into title, body and, if you're not the
> original
> -  author, a "Patch by" attribution line (see below).
> +* Separate the commit message into title and body separated by a blank
> line.
> +
> +* If you're not the original author, ensure the 'Author' property of the
> commit is
> +  set to the original author and the 'Committer' property is set to
> yourself.
> +  You can use a command similar to
> +  ``git commit --amend --author="John Doe <jdoe at llvm.org>`` to correct
> the
> +  author property if it is incorrect. See `Attribution of Changes`_ for
> more
> +  information including the method we used for attribution before the
> project
> +  migrated to git.
>
>  * The title should be concise. Because all commits are emailed to the
> list with
>    the first line as the subject, long titles are frowned upon.  Short
> titles
> @@ -314,11 +321,6 @@
>
>  * If the patch fixes a bug in bugzilla, please include the PR# in the
> message.
>
> -* `Attribution of Changes`_ should be in a separate line, after the end of
> -  the body, as simple as "Patch by John Doe.". This is how we officially
> -  handle attribution, and there are automated processes that rely on this
> -  format.
> -
>  * Text formatting and spelling should follow the same rules as
> documentation
>    and in-code comments, ex. capitalization, full stop, etc.
>
> @@ -340,6 +342,11 @@
>  quality patches.  If you would like commit access, please send an email to
>  `Chris <mailto:clattner at llvm.org>`_ with your GitHub username.
>
> +Prior to obtaining commit access, it is common practice to request that
> +someone with commit access commits on your behalf. When doing so, please
> +provide the name and email address you would like to use in the Author
> +property of the commit.
> +
>  Your first commit to a repository may require the autogenerated email to
> be
>  approved by a moderator of the mailing list.
>  This is normal and will be done when the mailing list owner has time.
> @@ -489,6 +496,11 @@
>  list, development list, or LLVM bug tracker component. If someone sends
> you
>  a patch privately, encourage them to submit it to the appropriate list
> first.
>
> +Our previous version control system (subversion) did not distinguish
> between the
> +author and the committer like git does. As such, older commits used a
> different
> +attribution mechanism. The previous method was to include "Patch by John
> Doe."
> +in a separate line of the commit message and there are automated
> processes that
> +rely on this format.
>
>  .. _IR backwards compatibility:
>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200109/39c62113/attachment.html>