diff --git a/README.md b/README.md new file mode 100644 index 0000000..934ec71 --- /dev/null +++ b/README.md @@ -0,0 +1,102 @@ +[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) +[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) +[![Open Source Helpers](https://www.codetriage.com/devncode/first-contributions/badges/users.svg)](https://www.codetriage.com/devncode/first-contributions) + +# First Contribution + +- Thinking about doing open source contribution? +- Don't know where to start or how to do? +- Looking for a simple repository to get started? + +Then look no further, we created this repository to get started. + +## just for the instruction! + +fork this repository + +If you don't have git on your machine, [install it]( https://help.github.com/articles/set-up-git/). + +## 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. + +## Clone the repository + +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. + +Open a terminal and run the following git command: + +``` +git clone "url you just copied" +``` + +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 + +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 +``` + +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.) + +## 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. + +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 Contributors.md +``` + +Now commit those changes using the `git commit` command: +``` +git commit -m "Add to Contributors list" +``` +replacing `` with your name. + +## Push changes to GitHub + +Push your changes using the command `git push`: +``` +git push origin +``` +replacing `` 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. + +create a pull request + +Now submit the pull request. + +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. diff --git a/assets/clone.png b/assets/clone.png new file mode 100644 index 0000000..2d28a33 Binary files /dev/null and b/assets/clone.png differ diff --git a/assets/compare-and-pull.png b/assets/compare-and-pull.png new file mode 100644 index 0000000..87cb164 Binary files /dev/null and b/assets/compare-and-pull.png differ diff --git a/assets/copy-to-clipboard.png b/assets/copy-to-clipboard.png new file mode 100644 index 0000000..9251734 Binary files /dev/null and b/assets/copy-to-clipboard.png differ diff --git a/assets/fork.png b/assets/fork.png new file mode 100644 index 0000000..d584b48 Binary files /dev/null and b/assets/fork.png differ diff --git a/assets/git-status.png b/assets/git-status.png new file mode 100644 index 0000000..90751cd Binary files /dev/null and b/assets/git-status.png differ diff --git a/assets/submit-pull-request.png b/assets/submit-pull-request.png new file mode 100644 index 0000000..d11098a Binary files /dev/null and b/assets/submit-pull-request.png differ