getting-started-with-open-source icon indicating copy to clipboard operation
getting-started-with-open-source copied to clipboard

Improve README: Add clearer steps for Git setup & first PR

Open Prasad-JB opened this issue 4 months ago • 4 comments

The current README is helpful, but it could be expanded to make it easier for newcomers (especially first-time contributors from programs like Hacktoberfest, GSoC, or NumFOCUS events).

Proposed improvements:

Add short guide for installing Git (with official link).

Show how to fork & clone the repo.

Add an example workflow for making the first pull request.

This will make the repository more beginner-friendly and align with the "Getting Started with Open Source" goal.

Prasad-JB avatar Aug 18 '25 08:08 Prasad-JB

Note to triager: OP has opened similar, probably AI generated issues in a few projects https://github.com/jupyter/notebook/issues/7701 https://github.com/matplotlib/matplotlib/issues/30427 https://github.com/pandas-dev/pandas/issues/62106

rcomer avatar Aug 18 '25 13:08 rcomer

Hi @rcomer, I understand your concern . This suggestion is genuine and not AI-generated. I’m trying to improve documentation for first-time contributors (since even I went through the same struggles) .

I’m happy to open a draft PR with the proposed README changes so maintainers can review and decide if it adds value.

Prasad-JB avatar Aug 19 '25 04:08 Prasad-JB

Hi, I’m new to contributing and would like to work on this issue. Could you please assign it to me?

klaus321901 avatar Sep 25 '25 14:09 klaus321901

Hi all, PR #40 implements the README improvements suggested here (Git setup, fork & clone instructions, and a first PR example). Once it’s reviewed and merged, this issue can be closed. Thanks.

Prasad-JB avatar Sep 29 '25 18:09 Prasad-JB