{"thread":{"id":"46117","subject":"[PATCH] docs: suggest \"Helped-by\" rather than \"Thanks-to\"","startedAt":"2017-06-05T10:54:47Z","lastAt":"2017-06-09T13:30:24Z","messageCount":6,"participants":["Adam Dinwoodie","Stefan Beller","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"321528","messageId":"20170605105341.35096-1-adam@dinwoodie.org","threadId":"46117","inReplyTo":null,"subject":"[PATCH] docs: suggest \"Helped-by\" rather than \"Thanks-to\"","fromName":"Adam Dinwoodie","fromEmail":"adam@dinwoodie.org","sentAt":"2017-06-05T10:53:41Z","receivedAt":"2017-06-05T10:54:47Z","isPatch":true,"sender":{"key":"adam@dinwoodie.org","avatar":"https://avatars.githubusercontent.com/u/1397507?v=4"},"body":"The SubmittingPatches doc suggests adding \"tags\" in the style of\n\"Signed-off-by\" to commit messages, and suggests some in common usage.\nHowever, based on usage on the Git mailing list (and in particular,\nJunio C Hamano's email to René Genz on 23 April), the suggested\n\"Thanks-to\" is not common usage, and should instead be \"Helped-by\".\n\nSigned-off-by: Adam Dinwoodie \n---\n Documentation/SubmittingPatches | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\nindex 558d465b6..2de42b3fa 100644\n--- a/Documentation/SubmittingPatches\n+++ b/Documentation/SubmittingPatches\n@@ -319,7 +319,7 @@ If you like, you can put extra tags at the end:\n and found it to have the desired effect.\n \n You can also create your own tag or use one that's in common usage\n-such as \"Thanks-to:\", \"Based-on-patch-by:\", or \"Mentored-by:\".\n+such as \"Helped-by:\", \"Based-on-patch-by:\", or \"Mentored-by:\".\n \n ------------------------------------------------\n Subsystems with dedicated maintainers\n-- \n2.12.3\n\n"},{"id":"321547","messageId":"CAGZ79kYZ2yTHxxRUjFZpFWsOWwmh6RBXRd0_a1K9kMTo4exD6A@mail.gmail.com","threadId":"46117","inReplyTo":"20170605105341.35096-1-adam@dinwoodie.org","subject":"Re: [PATCH] docs: suggest \"Helped-by\" rather than \"Thanks-to\"","fromName":"Stefan Beller","fromEmail":"sbeller@google.com","sentAt":"2017-06-05T18:42:31Z","receivedAt":"2017-06-05T18:42:42Z","isPatch":true,"sender":{"key":"stefanbeller@gmail.com","avatar":"https://avatars.githubusercontent.com/u/455868?v=4"},"body":"On Mon, Jun 5, 2017 at 3:53 AM, Adam Dinwoodie wrote:\n> The SubmittingPatches doc suggests adding \"tags\" in the style of\n> \"Signed-off-by\" to commit messages, and suggests some in common usage.\n> However, based on usage on the Git mailing list (and in particular,\n> Junio C Hamano's email to René Genz on 23 April), the suggested\n> \"Thanks-to\" is not common usage, and should instead be \"Helped-by\".\n>\n\nOne data point is sure nice (and it matches my perception),\nbut can we do data at project scale?\n\nThe quickest hack I could come up with is\n\n $ git log |grep Thanks-to |wc -l\n 57\n $ git log |grep Helped-by |wc -l\n 676\n\nwhich reinforces the underlying data.\n\n--\nSo I was wondering if there is a command that shows all trailers?\nSimilar to a \"shortlog -sne\" I would want to have a list of all trailers.\nThis is because there might be an even more popular trailer than\n\"Helped-by\", but we would not know when using the hack above.\n\nWhile I do not think so, it would sure be interesting to have a list\nof all these trailers available.\n\nThanks,\nStefan\n"},{"id":"321615","messageId":"20170606125743.GE25777@dinwoodie.org","threadId":"46117","inReplyTo":"CAGZ79kYZ2yTHxxRUjFZpFWsOWwmh6RBXRd0_a1K9kMTo4exD6A@mail.gmail.com","subject":"Re: [PATCH] docs: suggest \"Helped-by\" rather than \"Thanks-to\"","fromName":"Adam Dinwoodie","fromEmail":"adam@dinwoodie.org","sentAt":"2017-06-06T12:57:43Z","receivedAt":"2017-06-06T12:58:02Z","isPatch":true,"sender":{"key":"adam@dinwoodie.org","avatar":"https://avatars.githubusercontent.com/u/1397507?v=4"},"body":"On Mon, Jun 05, 2017 at 11:42:31AM -0700, Stefan Beller wrote:\n> So I was wondering if there is a command that shows all trailers?\n> Similar to a \"shortlog -sne\" I would want to have a list of all trailers.\n> This is because there might be an even more popular trailer than\n> \"Helped-by\", but we would not know when using the hack above.\n> \n> While I do not think so, it would sure be interesting to have a list\n> of all these trailers available.\n\nI just did a quick search with the following knocked-together command:\n\n git log --remotes --format=format:%B | sed -rn 's/^([A-Za-z0-9-]+): .* <.*@.*>.*/\\1/p' | sort | uniq -c | sort -nr\n\nThe top 10 such tags according to this (which is coincidentally the same\nlist as the list of all tags used more than 100 times), with\nfrequencies, are:\n\n 61535 Signed-off-by\n 1641 Acked-by\n 984 Reviewed-by\n 673 Helped-by\n 497 Reported-by\n 180 Cc\n 174 Suggested-by\n 159 Tested-by\n 158 Mentored-by\n 128 Noticed-by\n\nAs you might expect, there are a number of entertaining ones that have\nonly been used once or twice, such as \"Looks-fine-to-me-by\",\n\"Worriedly-Acked-by\", \"More-Spots-Found-By\", \"Looks-right-to-me-by\",\n\"Hopefully-signed-off-by\"...\n"},{"id":"321656","messageId":"xmqq7f0o8ywn.fsf@gitster.mtv.corp.google.com","threadId":"46117","inReplyTo":"20170606125743.GE25777@dinwoodie.org","subject":"Re: [PATCH] docs: suggest \"Helped-by\" rather than \"Thanks-to\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-06-06T23:44:08Z","receivedAt":"2017-06-06T23:44:18Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Adam Dinwoodie writes:\n\n> On Mon, Jun 05, 2017 at 11:42:31AM -0700, Stefan Beller wrote:\n>> So I was wondering if there is a command that shows all trailers?\n>> Similar to a \"shortlog -sne\" I would want to have a list of all trailers.\n>> This is because there might be an even more popular trailer than\n>> \"Helped-by\", but we would not know when using the hack above.\n>> \n>> While I do not think so, it would sure be interesting to have a list\n>> of all these trailers available.\n>\n> I just did a quick search with the following knocked-together command:\n>\n> git log --remotes --format=format:%B | sed -rn 's/^([A-Za-z0-9-]+): .* <.*@.*>.*/\\1/p' | sort | uniq -c | sort -nr\n>\n> The top 10 such tags according to this (which is coincidentally the same\n> list as the list of all tags used more than 100 times), with\n> frequencies, are:\n>\n> 61535 Signed-off-by\n> 1641 Acked-by\n> 984 Reviewed-by\n> 673 Helped-by\n> 497 Reported-by\n> 180 Cc\n> 174 Suggested-by\n> 159 Tested-by\n> 158 Mentored-by\n> 128 Noticed-by\n>\n> As you might expect, there are a number of entertaining ones that have\n> only been used once or twice, such as \"Looks-fine-to-me-by\",\n> \"Worriedly-Acked-by\", \"More-Spots-Found-By\", \"Looks-right-to-me-by\",\n> \"Hopefully-signed-off-by\"...\n\nThanks for an interesting list. Your replacing (totally\nunconventional) Thanks-to with more common Helped-by is certainly an\nimprovement, but I wonder if we should encourage people to be\n\"original\" in this area by having that \"You can also invent\"\nparagraph in the first place.\n"},{"id":"321738","messageId":"20170608084324.GG25777@dinwoodie.org","threadId":"46117","inReplyTo":"xmqq7f0o8ywn.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH] docs: suggest \"Helped-by\" rather than \"Thanks-to\"","fromName":"Adam Dinwoodie","fromEmail":"adam@dinwoodie.org","sentAt":"2017-06-08T08:43:24Z","receivedAt":"2017-06-08T08:44:04Z","isPatch":true,"sender":{"key":"adam@dinwoodie.org","avatar":"https://avatars.githubusercontent.com/u/1397507?v=4"},"body":"(Resending to everyone after only sending to Junio by mistake.)\n\nOn Wed, Jun 07, 2017 at 08:44:08AM +0900, Junio C Hamano wrote:\n> Adam Dinwoodie writes:\n> \n> > On Mon, Jun 05, 2017 at 11:42:31AM -0700, Stefan Beller wrote:\n> >> So I was wondering if there is a command that shows all trailers?\n> >> Similar to a \"shortlog -sne\" I would want to have a list of all trailers.\n> >> This is because there might be an even more popular trailer than\n> >> \"Helped-by\", but we would not know when using the hack above.\n> >> \n> >> While I do not think so, it would sure be interesting to have a list\n> >> of all these trailers available.\n> >\n> > I just did a quick search with the following knocked-together command:\n> >\n> > git log --remotes --format=format:%B | sed -rn 's/^([A-Za-z0-9-]+): .* <.*@.*>.*/\\1/p' | sort | uniq -c | sort -nr\n> >\n> > The top 10 such tags according to this (which is coincidentally the same\n> > list as the list of all tags used more than 100 times), with\n> > frequencies, are:\n> >\n> > 61535 Signed-off-by\n> > 1641 Acked-by\n> > 984 Reviewed-by\n> > 673 Helped-by\n> > 497 Reported-by\n> > 180 Cc\n> > 174 Suggested-by\n> > 159 Tested-by\n> > 158 Mentored-by\n> > 128 Noticed-by\n> >\n> > As you might expect, there are a number of entertaining ones that have\n> > only been used once or twice, such as \"Looks-fine-to-me-by\",\n> > \"Worriedly-Acked-by\", \"More-Spots-Found-By\", \"Looks-right-to-me-by\",\n> > \"Hopefully-signed-off-by\"...\n> \n> Thanks for an interesting list. Your replacing (totally\n> unconventional) Thanks-to with more common Helped-by is certainly an\n> improvement, but I wonder if we should encourage people to be\n> \"original\" in this area by having that \"You can also invent\"\n> paragraph in the first place.\n\nI would expect we could never come up with a list that will cover every\npossible scenario. I suppose the question is whether it's worse for\npeople to feel like it's encouraged to come up with non-standard options\nor for them to feel they can't deviate from a given list if none of the\navailable options suits them.\n\nAnd I definitely don't feel I have a good enough grasp of what these\nlines are used for in practice to make any sort of informed comment, so\nI shall leave it to people with more experience than I to propose the\npatch or not.\n"},{"id":"321829","messageId":"xmqqbmpx70go.fsf@gitster.mtv.corp.google.com","threadId":"46117","inReplyTo":"20170608084324.GG25777@dinwoodie.org","subject":"Re: [PATCH] docs: suggest \"Helped-by\" rather than \"Thanks-to\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-06-09T13:30:15Z","receivedAt":"2017-06-09T13:30:24Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Adam Dinwoodie writes:\n\n>> Thanks for an interesting list. Your replacing (totally\n>> unconventional) Thanks-to with more common Helped-by is certainly an\n>> improvement, but I wonder if we should encourage people to be\n>> \"original\" in this area by having that \"You can also invent\"\n>> paragraph in the first place.\n>\n> I would expect we could never come up with a list that will cover every\n> possible scenario. I suppose the question is whether it's worse for\n> people to feel like it's encouraged to come up with non-standard options\n> or for them to feel they can't deviate from a given list if none of the\n> available options suits them.\n\nI do not think we want to even aim for a canonical \"this is the ones\nyou must choose from\" in the first place. I felt that the current\ntext overly encourages to be \"creative\" there. I am wondering if an\nupdate like this, that explicitly says that \"Helped-by:\" is the\ncatch all for other kinds of help, would be sufficient?\n\n Documentation/SubmittingPatches | 11 +++++++----\n 1 file changed, 7 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\nindex 558d465b65..b49372b875 100644\n--- a/Documentation/SubmittingPatches\n+++ b/Documentation/SubmittingPatches\n@@ -305,7 +305,8 @@ the change to its true author (see (2) above).\n Also notice that a real name is used in the Signed-off-by: line. Please\n don't hide your real name.\n \n-If you like, you can put extra tags at the end:\n+If you like, you can put extra tags at the end. Here are the ones\n+that are commonly used in this project:\n \n 1. \"Reported-by:\" is used to credit someone who found the bug that\n the patch attempts to fix.\n@@ -317,9 +318,11 @@ If you like, you can put extra tags at the end:\n detailed review.\n 4. \"Tested-by:\" is used to indicate that the person applied the patch\n and found it to have the desired effect.\n-\n-You can also create your own tag or use one that's in common usage\n-such as \"Thanks-to:\", \"Based-on-patch-by:\", or \"Mentored-by:\".\n+5. \"Mentored-by:\" is often used by new contributors to give credits to\n+ a more experienced member of the list after privately getting help\n+ polishing the patches from, before showing the patch to the list.\n+6. \"Helped-by:\" is used to give credit to others involved in the\n+ discussion of the patch in other meaningful ways.\n \n ------------------------------------------------\n Subsystems with dedicated maintainers\n"}]}