First Pull Request

This project aims to help/guide beginners to make their first pull request.

---

If you already have experince with PRs

1. Fork this repo
2. Clone repo

git clone https://github.com/your_username/first-pull-request.git

3. Create a new branch

git checkout -b new-branch-name

4. Create a file your_username.json inside contributors folder with data

  {
    "name": "your_name"
  }

5. Commit your changes and push

git add your_username.json

git commit -m "add your_username"

git push origin your-created-branch-name

6. Create a Pull Request

---

Using Command Line

If you don't have git on your machine, install it.

1. Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

2. Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command :

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

For example :

git clone https://github.com/<your_username>/first-pull-request.git

where <your_username> is your GitHub username. Here you're copying the contents of the first-pull-request repository on GitHub to your computer.

3. Create a branch

Change to the repository directory on your computer (if you are not already there) :

cd first-contributions

Now create a branch using the git checkout command :

git checkout -b your-new-branch-name

For example :

git checkout -b add-harshraj8843

(The name of the branch does not need to have the word add in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a folder.)

4. Make necessary changes and commit those changes

Now create a file <your_username>.json inside contributors folder.

Add these lines inside <your_username>.json

{
  "name": "<your_name>"
}

where <your_username> is your GitHub username and <your_name> is your name.

For example :

harshraj8843.json with content

{
  "name": "Harsh Raj"
}

Now, save the file.

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command :

git add <your_username>.json

Now commit those changes using the git commit command :

git commit -m "add <your_username>"

replacing <your_username> with your Github username.

5. Push changes to GitHub

Push your changes using the command git push:

git push origin <add-your-branch-name>

replacing <add-your-branch-name> with the name of the branch you created earlier.

6. Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Now submit the pull request.

Soon your pull request will be reviewed and merged into the master branch of this project. You will get a notification email once the changes have been merged.

Where to go from here?

Congrats! You just completed the standard fork -> clone -> edit -> push -> pull request workflow that you'll encounter often as a contributor!

Celebrate your contribution and share it with your friends and followers.

You could contribute to our other open source projects

Thanks 💜

Thanks for all your contributions and efforts. We thank you being part of our ✨ community ✨ !