Re: [PATCH] docs: update contributing guide to refer current bugs and feature requests

From: Emily Shaffer <nasamuffin@google.com>
Date: Jan 8, 2025, 20:40 UTC
Message-ID: <CAJoAoZmzLOMNCNP-X-=QTSb=ed0GOkhx7w0PhVc2FmcbVL6jWQ@mail.gmail.com>
In-Reply-To: <pull.1867.git.git.1736080517950.gitgitgadget@gmail.com>

On Sun, Jan 5, 2025 at 4:35 AM Rhythm Narula via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 30 quoted lines

>
> From: Rhythm-26 <rhythm.narula26@gmail.com>
>
> The contributing guide is updated to include references to the current
> open bugs and feature requests. This update aims to improve visibility
> for contributors on where to find open issues and features that need
> attention.
>
> CC: Johannes Schindelin <johannes.schindelin@gmx.de>
> Signed-off-by: Rhythm-26 <rhythm.narula26@gmail.com>
> ---
>     docs: updates MyFirstContribution guide to refer current bugs and
>     feature requests
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1867%2FRhythm-26%2FupdateContirbutingDocumentation-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1867/Rhythm-26/updateContirbutingDocumentation-v1
> Pull-Request: https://github.com/git/git/pull/1867
>
>  Documentation/MyFirstContribution.txt | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
> index e41654c00a6..3b26a5265b2 100644
> --- a/Documentation/MyFirstContribution.txt
> +++ b/Documentation/MyFirstContribution.txt
> @@ -109,6 +109,14 @@ of invocation during users' typical daily workflow.
>  (We've seen some other effort in this space with the implementation of popular
>  commands such as `sl`.)
>
> +:mailinglist: git+subscribe@vger.kernel.org

What's the purpose of adding this attribute? Did you mean to use it to linkify "mailing list" in the first bullet below? Note that the mailing list and how to subscribe to it is also described above under "Getting Help", maybe it makes more sense to refer back to that header...? Not sure.

> +
> +Here's where you can find bugs and feature requests existing in the system:

I like the placement. The patch context doesn't make it super clear, but this is sitting at the end of the "Identify a Problem to Solve" step, so it's handy if folks are still following along in this guide on their first couple of real patches until they build muscle memory :) Initially I had thought this might make more sense to sit at the end of the tutorial, as a sort of "what do I do next?", but I think this placement is very good too.

Show 5 quoted lines

> +
> + - Git uses a mailing list for discussion on bugs, features and patches. Search for relevant topics or tagged issues
> +   like #leftoverbits in the archives: https://lore.kernel.org/git/
> + - Unofficial bug trackers - https://github.com/gitgitgadget/git/issues, https://git.issues.gerritcodereview.com/
> +

It could be nice to say something like "For next time, here's where you can find..." but I don't think it's necessary - my personal taste just thinks it could flow better.

Nice idea, though. With a couple tweaks I'd like to see it land.
Thanks for sending the patch.
 - Emily