-
-
Notifications
You must be signed in to change notification settings - Fork 46
Improve README with Git setup and first PR steps #46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,3 +19,63 @@ An Open Source sprint is a short event where groups of people get together to wo | |
|
|
||
| ### [Meet the Contributors](./open_source_stories.md) | ||
| About the contributors to this repo and their Open Source experience. | ||
|
|
||
|
|
||
| ## Getting Started: Git Setup & First Pull Request | ||
|
|
||
| If you are new to open source, follow these simple steps to make your | ||
| first contribution. | ||
|
|
||
| ### Step 1: Install Git | ||
| Download Git from: | ||
| https://git-scm.com/downloads | ||
|
|
||
| Check installation: | ||
| ```bash | ||
| git --version | ||
|
|
||
| ### Step 2: Configure Git | ||
| Set your name and email (required for commits): | ||
|
|
||
| ```bash | ||
| git config --global user.name "Your Name" | ||
| git config --global user.email "your@email.com" | ||
|
Comment on lines
+40
to
+42
|
||
|
|
||
| ### Step 3: Fork the Repository | ||
| Click the **Fork** button at the top-right of this repository. | ||
| This will create a copy of the repository under your GitHub account. | ||
|
|
||
| ### Step 4: Clone the Repository | ||
| Clone your fork to your local machine: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/YOUR-USERNAME/getting-started-with-open-source.git | ||
| cd getting-started-with-open-source | ||
|
Comment on lines
+51
to
+53
|
||
|
|
||
| ### Step 5: Create a New Branch | ||
| Create and switch to a new branch: | ||
| git checkout -b my-first-contribution | ||
|
||
|
|
||
| ### Step 6: Make Your Changes | ||
|
|
||
| Open README.md | ||
| Make your changes | ||
| Save the file | ||
|
Comment on lines
+61
to
+63
|
||
|
|
||
| ### Step 7: Commit Your Changes | ||
|
|
||
| Stage and commit your changes: | ||
|
|
||
| git add README.md | ||
| git commit -m "Improve README with Git setup and first PR steps" | ||
|
Comment on lines
+69
to
+70
|
||
|
|
||
| ### Step 8: Push Changes to GitHub | ||
| Push your branch to your fork: | ||
| git push origin my-first-contribution | ||
|
||
|
|
||
| ### Step 9: Create a Pull Request | ||
|
|
||
| Go to your fork on GitHub | ||
| Click Compare & Pull Request | ||
| Add a short description | ||
| Submit the PR | ||
|
Comment on lines
+78
to
+81
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.