 |
GitHub Desktop Edition |
|---|
It's hard. It's always hard the first time you do something. Especially when you are collaborating, making mistakes isn't a comfortable thing. But open source is all about collaboration & working together. We wanted to simplify the way new open-source contributors learn & contribute for the first time.
Reading articles & watching tutorials can help, but what comes better than actually doing the stuff without messing up anything. This project aims at providing guidance & simplifying the way rookies make their first contribution. Remember the more relaxed you are the better you learn. If you are looking for making your first contribution just follow the simple steps below. We promise you, it will be fun.
If you don't have GitHub Desktop on your machine, install it.
If you're using a version of GitHub desktop before 1.0, refer this tutorial.
Fork this repo by clicking on the fork button on the top right of this page. This will create a copy of this repository in your account.
Now clone this repo to your machine.
IMPORTANT: DO NOT CLONE THE ORIGINAL REPO. Go to your fork and clone it.
To clone the repo, click on "Clone or Download" and then click on "Open in Desktop".
A pop up window will open. Click on "Open GitHubDesktop.exe".
After you click on "Open GitHubDesktop.exe" the contents will be downloaded to your computer.
Now you have copied the contents of the first-contributions repository in github to your computer.
Now create a branch by clicking on the "Current branch" icon at the top and then click on "New branch":
Name your branch . For example, "add-james-smith"
Click on Create branch
Now, go to history tab and open Contributors.md file in a text editor by right clicking and open in text editor. Scroll to the bottom of the page and add your name to it, then save the file.
Example: If your name is James Smith, It should look like this.
[James Smith](https://github.com/jamessmith)
You can see that there are changes to Contributors.md and they have been added to the Github Desktop.
Now commit those changes:
Write the message "Add <your-name> to Contributors list" in the summary field.
Replace <your-name> with your name.
Click on the button that says Commit to add-your-name.
At the bottom, you can see that the commit has been created.
Click on File->Options and sign-in to Github.com. Type in your Github username and password.
Click the Publish button on the top right.
If you go to your repository on github, you'll see Compare & pull request button. click on that button.
Now submit the 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.
Congrats! You just completed the standard fork -> clone -> edit -> PR workflow that you'll encounter often as a contributor!
Celebrate your contribution and share it with your friends and followers by going to web app.
You can join our slack team in case you need any help or have any questions. Join slack team.