Improve README with Git setup and first PR steps #46
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a beginner-friendly "Getting Started" section to the README that guides newcomers through Git setup and creating their first pull request. The addition provides step-by-step instructions covering Git installation, configuration, repository forking, cloning, branching, making changes, committing, pushing, and creating a pull request.
Key Changes:
- Added a new "Getting Started: Git Setup & First Pull Request" section with 9 detailed steps
- Provided command-line examples for Git operations
- Included instructions for forking and cloning the repository
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| git config --global user.name "Your Name" | ||
| git config --global user.email "your@email.com" |
There was a problem hiding this comment.
The code block for Git configuration is not properly closed. Missing the closing triple backticks (```) at the end of the code block before Step 3 begins.
| ```bash | ||
| git clone https://github.com/YOUR-USERNAME/getting-started-with-open-source.git | ||
| cd getting-started-with-open-source |
There was a problem hiding this comment.
The code block for cloning the repository is not properly closed. Missing the closing triple backticks (```) at the end of the code block before Step 5 begins.
|
|
||
| ### Step 5: Create a New Branch | ||
| Create and switch to a new branch: | ||
| git checkout -b my-first-contribution |
There was a problem hiding this comment.
This command should be formatted as a code block with triple backticks (```) for consistency with the other steps in this section.
| Open README.md | ||
| Make your changes | ||
| Save the file |
There was a problem hiding this comment.
These instructions should be formatted as a proper list or code block for consistency with the rest of the documentation. Currently they appear as plain text without formatting.
| git add README.md | ||
| git commit -m "Improve README with Git setup and first PR steps" |
There was a problem hiding this comment.
These commands should be formatted as a code block with triple backticks (```) for consistency with the other steps in this section.
|
|
||
| ### Step 8: Push Changes to GitHub | ||
| Push your branch to your fork: | ||
| git push origin my-first-contribution |
There was a problem hiding this comment.
This command should be formatted as a code block with triple backticks (```) for consistency with the other steps in this section.
| Go to your fork on GitHub | ||
| Click Compare & Pull Request | ||
| Add a short description | ||
| Submit the PR No newline at end of file |
There was a problem hiding this comment.
These instructions should be formatted as a proper list (with bullet points or numbered sub-items) for consistency with the rest of the documentation. Currently they appear as plain text without formatting.
| ```bash | ||
| git --version | ||
|
|
There was a problem hiding this comment.
The code block for Git version check is not properly closed. Missing the closing triple backticks (```) at the end of the code block before Step 2 begins.
1 participant
This PR adds a beginner-friendly section explaining Git setup
and how to make a first pull request.
Fixes #37