git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] docs: suggest "Helped-by" rather than "Thanks-to"

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 9, 2017, 13:30 UTC
Message-ID
<xmqqbmpx70go.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20170608084324.GG25777@dinwoodie.org>
Adam Dinwoodie <adam@dinwoodie.org> writes:
Show 11 quoted lines
>> Thanks for an interesting list.  Your replacing (totally
>> unconventional) Thanks-to with more common Helped-by is certainly an
>> improvement, but I wonder if we should encourage people to be
>> "original" in this area by having that "You can also invent"
>> paragraph in the first place.
>
> I would expect we could never come up with a list that will cover every
> possible scenario. I suppose the question is whether it's worse for
> people to feel like it's encouraged to come up with non-standard options
> or for them to feel they can't deviate from a given list if none of the
> available options suits them.

I do not think we want to even aim for a canonical "this is the ones you must choose from" in the first place. I felt that the current text overly encourages to be "creative" there. I am wondering if an update like this, that explicitly says that "Helped-by:" is the catch all for other kinds of help, would be sufficient?

 Documentation/SubmittingPatches | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 558d465b65..b49372b875 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -305,7 +305,8 @@ the change to its true author (see (2) above).
 Also notice that a real name is used in the Signed-off-by: line. Please
 don't hide your real name.
 
-If you like, you can put extra tags at the end:
+If you like, you can put extra tags at the end.  Here are the ones
+that are commonly used in this project:
 
 1. "Reported-by:" is used to credit someone who found the bug that
    the patch attempts to fix.
@@ -317,9 +318,11 @@ If you like, you can put extra tags at the end:
    detailed review.
 4. "Tested-by:" is used to indicate that the person applied the patch
    and found it to have the desired effect.
-
-You can also create your own tag or use one that's in common usage
-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
+5. "Mentored-by:" is often used by new contributors to give credits to
+   a more experienced member of the list after privately getting help
+   polishing the patches from, before showing the patch to the list.
+6. "Helped-by:" is used to give credit to others involved in the
+   discussion of the patch in other meaningful ways.
 
 ------------------------------------------------
 Subsystems with dedicated maintainers
Previous: Adam Dinwoodie
Message 6 of 6 in “docs: suggest "Helped-by" rather than "Thanks-to"”
  1. docs: suggest "Helped-by" rather than "Thanks-to"Adam Dinwoodie, Jun 5, 2017
  2. Stefan BellerJun 5, 2017
  3. Adam DinwoodieJun 6, 2017
  4. Junio C HamanoJun 6, 2017
  5. Adam DinwoodieJun 8, 2017
  6. Junio C HamanoJun 9, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.