Skip to content

Commit

Permalink
update readme with fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
rehan-sattar committed Oct 10, 2019
1 parent 6196a98 commit b685754
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

- Thinking about doing open source contribution?
- Don't know where to start or how to do?
- Looking for a simple repository to get started?
- Looking for a simple repository to help you to get started?

Then look no further, we created this repository to get started.
Then look no further, we have created this repository to help you to get started.

## just for the instruction!
## Just for the instruction!

<img align="right" width="300" src="assets/fork.png" alt="fork this repository" />

If you don't have git on your machine, [install it]( https://help.github.com/articles/set-up-git/).
If you don't have git installed in your machine, [install it](https://help.github.com/articles/set-up-git/).

## Fork this repository

Expand All @@ -25,7 +25,7 @@ This will create a copy of this repository in your account.

<img align="right" width="300" src="assets/clone.png" alt="clone this repository" />

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

Open a terminal and run the following git command:

Expand All @@ -36,9 +36,11 @@ git clone "url you just copied"
<img align="right" width="300" src="assets/copy-to-clipboard.png" alt="copy URL to clipboard" />

For example:

```
git clone https://github.com/this-is-you/first-contributions.git
```

where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository in GitHub to your computer.

## Create a branch
Expand All @@ -48,55 +50,61 @@ Change to the repository directory on your computer (if you are not already ther
```
cd first-contributions
```

Now create a branch using the `git checkout` command:

```
git checkout -b <add-your-new-branch-name>
```

For example:

```
git checkout -b add-muhammad
```
(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 list.)

(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 list.)

## Make necessary changes and commit those changes

Now open `contributions.yml` file from `_data` directory in a text editor, add your name, github_account and profile picture url (avatar) to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.

<img align="right" width="450" src="assets/git-status.png" alt="git status" />


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 contributions.yml
git add _data/contributions.yml
```

Now commit those changes using the `git commit` command:

```
git commit -m "Add <your-name> to Contributors list"
```
replacing `<your-name>` with your name.

replace `<your-name>` with your name.

## 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.

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

## 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 if you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.

<img style="float: right;" src="assets/compare-and-pull.png" alt="create a pull request" />

Now submit the pull request.

<img style="float: right;" src="assets/submit-pull-request.png" alt="submit pull request" />

Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.
Soon, I'll be merging all your pull requests into the master branch of this project. You will get a notification email once the changes have been merged.

0 comments on commit b685754

Please sign in to comment.