mirror of
https://github.com/LucasVbr/first-contributions.git
synced 2026-05-13 17:21:50 +00:00
Yidnekachew S.
3d5158f9ec
Added two steps with two images to the github-desktop-tutorial.md and removed the slack link at the top and bottom of the tutorial.
120 lines
6.4 KiB
Markdown
120 lines
6.4 KiB
Markdown
[](https://github.com/ellerbrock/open-source-badges/)
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://www.codetriage.com/roshanjossey/first-contributions)
|
|
|
|
# First Contributions
|
|
|
|
| <img alt="GitHub Desktop" src="https://desktop.github.com/images/desktop-icon.svg" width="200"> | 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](https://desktop.github.com/).
|
|
|
|
If you're using a version of GitHub desktop before 1.0, [refer to this tutorial](github-desktop-old-version-tutorial.md).
|
|
|
|
<img align="right" width="300" src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/fork.png" alt="fork this repository" />
|
|
|
|
## Fork this repository
|
|
|
|
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.
|
|
|
|
## Clone the repository
|
|
|
|
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".
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-clonetodesktop.png" alt="clone this repository" />
|
|
|
|
A pop up window will open. Click on "Open GitHubDesktop.exe".
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-open-githubdesktop.png" alt="clone this repository" />
|
|
|
|
After you click on "Open GitHubDesktop.exe" a 'Clone a repository' dialogue box appears. Click on 'Clone'.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/clone-repository.png" alt="clone this repository" height="400" />
|
|
|
|
After that another dialogue box that says 'How are you planning to use this fork?' appears. Select 'To contribute to the parent project' and click on 'Continue'.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/repository-clone-purpose.png" alt="Use of repository" height="500" />
|
|
|
|
Now you have copied the contents of the first-contributions repository in github to your computer.
|
|
|
|
## Create a branch
|
|
|
|
Now create a branch by clicking on the "Current branch" icon at the top and then click on "New branch":
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-create-branch.png" alt="make a branch" />
|
|
|
|
Name your branch <add-your-name>. For example, "add-james-smith"
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-create-branch-name.png" alt="name your branch" />
|
|
|
|
Click on `Create branch`
|
|
|
|
## Make necessary changes and commit those changes
|
|
|
|
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.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-status.png" alt="check status" />
|
|
|
|
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`.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-commit1.png" alt="commit your changes" />
|
|
|
|
At the bottom, you can see that the commit has been created.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-commit2.png" alt="commit your changes" />
|
|
|
|
## Push changes to github
|
|
|
|
Click on File->Options and sign-in to Github.com. Type in your Github username and password.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-sign-in.png" alt="log-in to Github" />
|
|
|
|
Click the `Publish` button on the top right.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/dt1-publish1.png" alt="push your changes" />
|
|
|
|
## Submit your changes for review
|
|
|
|
If you go to your repository on github, you'll see `Compare & pull request` button. click on that button.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/compare-and-pull.png" alt="create a pull request" />
|
|
|
|
Now submit the pull request.
|
|
|
|
<img src="https://firstcontributions.github.io/assets/gui-tool-tutorials/github-desktop-tutorial/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.
|
|
|
|
## Where to go from here?
|
|
|
|
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](https://firstcontributions.github.io#social-share).
|
|
|
|
### [Additional material](../additional-material/git_workflow_scenarios/additional-material.md)
|
|
|
|
## Tutorials Using Other Tools
|
|
|
|
[Back to main page](https://github.com/firstcontributions/first-contributions#tutorials-using-other-tools)
|