{"thread":{"id":"62742","subject":"[PATCH] docs: update contributing guide to refer current bugs and feature requests","startedAt":"2025-01-05T12:35:21Z","lastAt":"2025-01-14T17:24:16Z","messageCount":5,"participants":["Rhythm Narula via GitGitGadget","Carlo Marcelo Arenas Belón","Emily Shaffer","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"509927","messageId":"pull.1867.git.git.1736080517950.gitgitgadget@gmail.com","threadId":"62742","inReplyTo":null,"subject":"[PATCH] docs: update contributing guide to refer current bugs and feature requests","fromName":"Rhythm Narula via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-05T12:35:17Z","receivedAt":"2025-01-05T12:35:21Z","isPatch":true,"sender":{"key":"rhythm.narula26@gmail.com","avatar":"https://gravatar.com/avatar/4b26775567d9a6f7921c7c07499f1e4d377b524468036dd38a88d1823d0d1e3a?d=mp&s=160"},"body":"From: Rhythm-26 \n\nThe contributing guide is updated to include references to the current\nopen bugs and feature requests. This update aims to improve visibility\nfor contributors on where to find open issues and features that need\nattention.\n\nCC: Johannes Schindelin \nSigned-off-by: Rhythm-26 \n---\n docs: updates MyFirstContribution guide to refer current bugs and\n feature requests\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1867%2FRhythm-26%2FupdateContirbutingDocumentation-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1867/Rhythm-26/updateContirbutingDocumentation-v1\nPull-Request: https://github.com/git/git/pull/1867\n\n Documentation/MyFirstContribution.txt | 8 ++++++++\n 1 file changed, 8 insertions(+)\n\ndiff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt\nindex e41654c00a6..3b26a5265b2 100644\n--- a/Documentation/MyFirstContribution.txt\n+++ b/Documentation/MyFirstContribution.txt\n@@ -109,6 +109,14 @@ of invocation during users' typical daily workflow.\n (We've seen some other effort in this space with the implementation of popular\n commands such as `sl`.)\n \n+:mailinglist: git+subscribe@vger.kernel.org\n+\n+Here's where you can find bugs and feature requests existing in the system:\n+\n+ - Git uses a mailing list for discussion on bugs, features and patches. Search for relevant topics or tagged issues\n+ like #leftoverbits in the archives: https://lore.kernel.org/git/\n+ - Unofficial bug trackers - https://github.com/gitgitgadget/git/issues, https://git.issues.gerritcodereview.com/\n+\n [[setup-workspace]]\n === Set Up Your Workspace\n \n\nbase-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694\n-- \ngitgitgadget\n"},{"id":"510152","messageId":"cwkdvlhhfe6lrgx5pdcrgmgv7cfvkjflazo4k4yorzbuaixlpn@myd7rrdel3w6","threadId":"62742","inReplyTo":"pull.1867.git.git.1736080517950.gitgitgadget@gmail.com","subject":"Re: [PATCH] docs: update contributing guide to refer current bugs and feature requests","fromName":"Carlo Marcelo Arenas Belón","fromEmail":"carenas@gmail.com","sentAt":"2025-01-08T10:43:58Z","receivedAt":"2025-01-08T10:44:00Z","isPatch":true,"sender":{"key":"carenas@gmail.com","avatar":"https://avatars.githubusercontent.com/u/76036?v=4"},"body":"On Sun, Jan 05, 2025 at 12:35:17PM -0800, Rhythm Narula via GitGitGadget wrote:\n> From: Rhythm-26 \n> \n> The contributing guide is updated to include references to the current\n> open bugs and feature requests. This update aims to improve visibility\n> for contributors on where to find open issues and features that need\n> attention.\n\nThe commit message (as described in `Documentation/SubmittingPatches`)\nshould explain the problem in the codebase and then describe (in imperative\nmode) how the patch proposes to fix it.\n\nSubject line is also meant to be very short so maybe somethihg like:\n\n docs: mention source of tasks in MyFirstContribution\n\n> +:mailinglist: git+subscribe@vger.kernel.org\n> +\n> +Here's where you can find bugs and feature requests existing in the system:\n\nmentioning bugs with quotes might be a good idea, considering that GGG\n(your first link below) specifically mentions that only feature requests\nshould be filed there.\n\nsomething that encourages people to use the mailing list for reports and\ndiscussion probably worth adding as well.\n\n\n> + - Unofficial bug trackers - https://github.com/gitgitgadget/git/issues, https://git.issues.gerritcodereview.com/\n\nsee #1432\n\nCarlo\n\nCC: +Emily as the original authour of \"MyFirstContribution\" for feedback\n"},{"id":"510202","messageId":"CAJoAoZmzLOMNCNP-X-=QTSb=ed0GOkhx7w0PhVc2FmcbVL6jWQ@mail.gmail.com","threadId":"62742","inReplyTo":"pull.1867.git.git.1736080517950.gitgitgadget@gmail.com","subject":"Re: [PATCH] docs: update contributing guide to refer current bugs and feature requests","fromName":"Emily Shaffer","fromEmail":"nasamuffin@google.com","sentAt":"2025-01-08T20:40:09Z","receivedAt":"2025-01-08T20:40:21Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"On Sun, Jan 5, 2025 at 4:35 AM Rhythm Narula via GitGitGadget\n wrote:\n>\n> From: Rhythm-26 \n>\n> The contributing guide is updated to include references to the current\n> open bugs and feature requests. This update aims to improve visibility\n> for contributors on where to find open issues and features that need\n> attention.\n>\n> CC: Johannes Schindelin \n> Signed-off-by: Rhythm-26 \n> ---\n> docs: updates MyFirstContribution guide to refer current bugs and\n> feature requests\n>\n> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1867%2FRhythm-26%2FupdateContirbutingDocumentation-v1\n> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1867/Rhythm-26/updateContirbutingDocumentation-v1\n> Pull-Request: https://github.com/git/git/pull/1867\n>\n> Documentation/MyFirstContribution.txt | 8 ++++++++\n> 1 file changed, 8 insertions(+)\n>\n> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt\n> index e41654c00a6..3b26a5265b2 100644\n> --- a/Documentation/MyFirstContribution.txt\n> +++ b/Documentation/MyFirstContribution.txt\n> @@ -109,6 +109,14 @@ of invocation during users' typical daily workflow.\n> (We've seen some other effort in this space with the implementation of popular\n> commands such as `sl`.)\n>\n> +:mailinglist: git+subscribe@vger.kernel.org\n\nWhat's the purpose of adding this attribute? Did you mean to use it to\nlinkify \"mailing list\" in the first bullet below? Note that the\nmailing list and how to subscribe to it is also described above under\n\"Getting Help\", maybe it makes more sense to refer back to that\nheader...? Not sure.\n\n> +\n> +Here's where you can find bugs and feature requests existing in the system:\n\nI like the placement. The patch context doesn't make it super clear,\nbut this is sitting at the end of the \"Identify a Problem to Solve\"\nstep, so it's handy if folks are still following along in this guide\non their first couple of real patches until they build muscle memory\n:) Initially I had thought this might make more sense to sit at the\nend of the tutorial, as a sort of \"what do I do next?\", but I think\nthis placement is very good too.\n\n> +\n> + - Git uses a mailing list for discussion on bugs, features and patches. Search for relevant topics or tagged issues\n> + like #leftoverbits in the archives: https://lore.kernel.org/git/\n> + - Unofficial bug trackers - https://github.com/gitgitgadget/git/issues, https://git.issues.gerritcodereview.com/\n> +\n\n\n\nIt could be nice to say something like \"For next time, here's where\nyou can find...\" but I don't think it's necessary - my personal taste\njust thinks it could flow better.\n\nNice idea, though. With a couple tweaks I'd like to see it land.\nThanks for sending the patch.\n - Emily\n"},{"id":"510483","messageId":"pull.1867.v2.git.git.1736844538005.gitgitgadget@gmail.com","threadId":"62742","inReplyTo":"pull.1867.git.git.1736080517950.gitgitgadget@gmail.com","subject":"[PATCH v2] docs: mention source of tasks in MyFirstContribution","fromName":"Rhythm Narula via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-14T08:48:57Z","receivedAt":"2025-01-14T08:49:01Z","isPatch":true,"sender":{"key":"rhythm.narula26@gmail.com","avatar":"https://gravatar.com/avatar/4b26775567d9a6f7921c7c07499f1e4d377b524468036dd38a88d1823d0d1e3a?d=mp&s=160"},"body":"From: Rhythm-26 \n\nMyFirstContribution guide lacks clear guidance on where to access\nlist of bugs or feature requests. Improve visibility for contributors\non where to find open issues and features that need attention.\n\nCC: Johannes Schindelin \nSigned-off-by: Rhythm-26 \n---\n docs: updates MyFirstContribution guide to refer current bugs and\n feature requests\n \n cc: Carlo Marcelo Arenas Belón carenas@gmail.com cc: Emily Shaffer\n nasamuffin@google.com\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1867%2FRhythm-26%2FupdateContirbutingDocumentation-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1867/Rhythm-26/updateContirbutingDocumentation-v2\nPull-Request: https://github.com/git/git/pull/1867\n\nRange-diff vs v1:\n\n 1: d3e264b1cc5 ! 1: d1e83439133 docs: update contributing guide to refer current bugs and feature requests\n @@ Metadata\n Author: Rhythm-26 \n \n ## Commit message ##\n - docs: update contributing guide to refer current bugs and feature requests\n + docs: mention source of tasks in MyFirstContribution\n \n - The contributing guide is updated to include references to the current\n - open bugs and feature requests. This update aims to improve visibility\n - for contributors on where to find open issues and features that need\n - attention.\n + MyFirstContribution guide lacks clear guidance on where to access\n + list of bugs or feature requests. Improve visibility for contributors\n + on where to find open issues and features that need attention.\n \n CC: Johannes Schindelin \n Signed-off-by: Rhythm-26 \n @@ Documentation/MyFirstContribution.txt: of invocation during users' typical daily\n \n +:mailinglist: git+subscribe@vger.kernel.org\n +\n -+Here's where you can find bugs and feature requests existing in the system:\n ++For future reference, here's where you can find bugs and feature requests existing in the system:\n +\n + - Git uses a mailing list for discussion on bugs, features and patches. Search for relevant topics or tagged issues\n -+ like #leftoverbits in the archives: https://lore.kernel.org/git/\n -+ - Unofficial bug trackers - https://github.com/gitgitgadget/git/issues, https://git.issues.gerritcodereview.com/\n ++ like #leftoverbits in the archives: https://lore.kernel.org/git/. If you encounter a bug, have a feature request,\n ++ or wish to discuss or share suggestions, please use the mailing list. You can find more details in the <> section.\n ++ - Unofficial bug trackers - https://github.com/gitgitgadget/git/issues [NOTE: This is for feature requests only],\n ++ https://git.issues.gerritcodereview.com/\n +\n [[setup-workspace]]\n === Set Up Your Workspace\n\n\n Documentation/MyFirstContribution.txt | 10 ++++++++++\n 1 file changed, 10 insertions(+)\n\ndiff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt\nindex e41654c00a6..630a68b650c 100644\n--- a/Documentation/MyFirstContribution.txt\n+++ b/Documentation/MyFirstContribution.txt\n@@ -109,6 +109,16 @@ of invocation during users' typical daily workflow.\n (We've seen some other effort in this space with the implementation of popular\n commands such as `sl`.)\n \n+:mailinglist: git+subscribe@vger.kernel.org\n+\n+For future reference, here's where you can find bugs and feature requests existing in the system:\n+\n+ - Git uses a mailing list for discussion on bugs, features and patches. Search for relevant topics or tagged issues\n+ like #leftoverbits in the archives: https://lore.kernel.org/git/. If you encounter a bug, have a feature request,\n+ or wish to discuss or share suggestions, please use the mailing list. You can find more details in the <> section.\n+ - Unofficial bug trackers - https://github.com/gitgitgadget/git/issues [NOTE: This is for feature requests only],\n+ https://git.issues.gerritcodereview.com/\n+\n [[setup-workspace]]\n === Set Up Your Workspace\n \n\nbase-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694\n-- \ngitgitgadget\n"},{"id":"510526","messageId":"xmqq1px55mwy.fsf@gitster.g","threadId":"62742","inReplyTo":"pull.1867.v2.git.git.1736844538005.gitgitgadget@gmail.com","subject":"Re: [PATCH v2] docs: mention source of tasks in MyFirstContribution","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-01-14T17:24:13Z","receivedAt":"2025-01-14T17:24:16Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Rhythm Narula via GitGitGadget\" writes:\n\n> From: Rhythm-26 \n>\n> MyFirstContribution guide lacks clear guidance on where to access\n> list of bugs or feature requests. Improve visibility for contributors\n> on where to find open issues and features that need attention.\n>\n> CC: Johannes Schindelin \n> Signed-off-by: Rhythm-26 \n> ---\n> docs: updates MyFirstContribution guide to refer current bugs and\n> feature requests\n> \n> cc: Carlo Marcelo Arenas Belón carenas@gmail.com cc: Emily Shaffer\n> nasamuffin@google.com\n\nLet me remind you of Documentation/SubmittingPatches[[real-name]],\nin case your name is not \"26\". We want to see \"From:\" (you used\nGitgitgadget, and it placed an in-body \"From:\" at the beginning of\nthe message, which is expected---there is a name there and we want\nit to match the name used on the \"Signed-off-by:\" line below) and\n\"Signed-off-by:\" use the same name that we can say, when the court\nasks if we stole a part of this software from somebody else, \"no,\nwe didn't steal it. this person (with his or her real name) sent a\ncontribution to us and here is our record\".\n\n> - docs: update contributing guide to refer current bugs and feature requests\n> + docs: mention source of tasks in MyFirstContribution\n\nNice.\n\n> \n> - The contributing guide is updated to include references to the current\n> - open bugs and feature requests. This update aims to improve visibility\n> - for contributors on where to find open issues and features that need\n> - attention.\n> + MyFirstContribution guide lacks clear guidance on where to access\n> + list of bugs or feature requests. Improve visibility for contributors\n> + on where to find open issues and features that need attention.\n\n\"MyFirstContribution guide\" -> \"MyFirstContribution\" would be\nsufficient; it also allows us to avoid \"guide ... guidance\"\nduplication.\n\nIf I were writing it, I would also do \"access list of\" -> \"find\nunresolved\". We do not have \"the official and curated list of bugs\nand feature requests\", so such a thing by definition cannot be\naccessed.\n\n> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt\n> index e41654c00a6..630a68b650c 100644\n> --- a/Documentation/MyFirstContribution.txt\n> +++ b/Documentation/MyFirstContribution.txt\n> @@ -109,6 +109,16 @@ of invocation during users' typical daily workflow.\n> (We've seen some other effort in this space with the implementation of popular\n> commands such as `sl`.)\n> \n> +:mailinglist: git+subscribe@vger.kernel.org\n\nI recall seeing that Emily asked about this line and do not remember\never seeing an answer to it.\n\nhttps://lore.kernel.org/git/CAJoAoZmzLOMNCNP-X-=QTSb=ed0GOkhx7w0PhVc2FmcbVL6jWQ@mail.gmail.com/\n\n\nThe paragraph below is overly wide. Please make sure that the\nresulting document _before_ passing AsciiDoc can comfortably be read\non 80-column terminals. We usually try to limit the line width to a\ntad shorter than that limit, because we review via e-mail ...\n\n> +For future reference, here's where you can find bugs and feature requests existing in the system:\n\n... and quoted lines will be indented to lose a handful of columns\non the left edge. From here on, I'll liberally fold your original\nbefore commenting.\n\n\n> For future reference, here's where you can find bugs and feature\n> requests existing in the system:\n\nIt is a bit funny to phrase requests to \"exist in the system\". It\nis still outside of the system and that is why they are requests.\n\nSince this is the \"my first *contribution*\" document, phrasing it\nmore like \"unresolved bugs and feature requests you can work on\"\nwould fit the purpose of the doucment better, perhaps?\n\n If you are interested, here are a few ways to find unresolved\n bugs and feature requests you can work on:\n\nor something like that.\n\n> - Git uses a mailing list for discussion on bugs, features and\n> patches. Search for relevant topics or tagged issues like\n> #leftoverbits in the archives: https://lore.kernel.org/git/.\n\nI am of two minds about #leftoverbits. It certainly is an easy way\nto leave notes for later investigation for writers, and it is an\neasy way to find them later when somebody is bored enough to find\nthings to work on. On the mailing list, however, anybody can say\nanything [*], so an ancient uttering made by somebody with the\n\"#leftoverbits\" mark may just be a feature request that turned out\nnot make sense at all.\n\n> If\n> you encounter a bug, have a feature request, or wish to discuss or\n> share suggestions, please use the mailing list. You can find more\n> details in the <> section.\n\nThis is great. We should also suggest \"search the list archive for\nsimilar issues\", but that needs to be phrased with finesse, because\nit probably is not useful use of potential contributor's time [*]\nand may raise the bar to report potential issues if we require it.\n\nMaking it entirely optional, but still encouraging, to dig in the\narchive, here is what I came up with, but it is overly long. If\nsomebody agrees with the direction, we need to spend time to make it\nmore concise:\n\n You may find a bug or have a feature request. Since Git has a\n huge user base, it is not all that unlikely that somebody else\n has already encountered the same bug. Looking for similar\n reports on the mailing list may even find that the bug has\n already been fixed.\n\n But looking for similar bugs and feature requests on the mailing\n list take certain spelunking skills; do not be afraid of sending\n a bug report that turns out to be a duplicate. If somebody\n recently worked on the same bug or a similar new feature, they\n may respond a lot faster than you can dig recent exchanges out\n of the list archive (in other words, inadvertent duplicate\n reports are encouraged).\n\n> - Unofficial bug trackers \n> - https://github.com/gitgitgadget/git/issues [NOTE: This is for\n> feature requests only]\n> - https://git.issues.gerritcodereview.com/\n\nOK.\n\nThanks.\n\n\n[Footnotes]\n\n* Of course, community guidelines apply and rude folks may be kicked\n out, but it should be clear that I am not talking about that kind\n of \"can say anything\" in the context of this message ;-).\n\n* But if we say that, a new question \"is it worth the time for\n established community members to do the list search for them,\n then?\" arises (and the answer is usually \"No\"). But if somebody\n already knows that a similar issue was reported, or better yet,\n that the issue has already been resolved, then exposing the\n duplicate issue this new person found to the list and let the\n duplicate report noticed by that somebody would be an overall win.\n"}]}