diff --git a/README.md b/README.md index c56d01d778ca92ce6ff5bc8bf2694ba57ac8637f..c7d6fb90af8101ac039dfb2092d3b4e2448f9189 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [](https://www.codetriage.com/roshanjossey/first-contributions) -# First Contributions +Alt First Contributions 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. We wanted to simplify the way new open-source contributors learn & contribute for the first time. @@ -61,12 +61,12 @@ Reading articles & watching tutorials can help, but what's better than actually If you don't have git on your machine, [install it]( https://help.github.com/articles/set-up-git/). -## Fork this repository +Alt 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 +Alt Clone the repository <img align="right" width="300" src="assets/clone.png" alt="clone this repository" /> @@ -87,7 +87,7 @@ 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 +Alt Create a branch Change to the repository directory on your computer (if you are not already there): @@ -105,7 +105,7 @@ git checkout -b add-alonzo-church ``` (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 +Alt Make necessary changes and commit those changes Now open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file. @@ -127,7 +127,7 @@ git commit -m "Add <your-name> to Contributors list" ``` replacing `<your-name>` with your name. -## Push changes to GitHub +Alt Push changes to GitHub Push your changes using the command `git push`: ``` @@ -135,7 +135,7 @@ git push origin <add-your-branch-name> ``` replacing `<add-your-branch-name>` with the name of the branch you created earlier. -## Submit your changes for review +Alt 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. @@ -147,7 +147,7 @@ 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. -## Where to go from here? +Alt Where to go from here? Congrats! You just completed the standard _fork -> clone -> edit -> PR_ workflow that you'll encounter often as a contributor! @@ -157,16 +157,16 @@ You could join our slack team in case you need any help or have any questions. [ Now let's get you started with contributing to other projects. We've compiled a list of projects with easy issues you can get started on. Check out [the list of projects in web app](https://roshanjossey.github.io/first-contributions/#project-list). -### [Additional material](additional-material/git_workflow_scenarios/additional-material.md) +Alt [Additional material](additional-material/git_workflow_scenarios/additional-material.md) -## Tutorials Using Other Tools +Alt Tutorials Using Other Tools |<a href="github-desktop-tutorial.md"><img alt="GitHub Desktop" src="https://desktop.github.com/images/desktop-icon.svg" width="100"></a>|<a href="github-windows-vs2017-tutorial.md"><img alt="Visual Studio 2017" src="https://www.visualstudio.com/wp-content/uploads/2017/11/microsoft-visual-studio.svg" width="100"></a>|<a href="gitkraken-tutorial.md"><img alt="GitKraken" src="/assets/gk-icon.png" width="100"></a>|<a href="github-windows-vs-code-tutorial.md"><img alt="VS Code" src="https://upload.wikimedia.org/wikipedia/commons/2/2d/Visual_Studio_Code_1.18_icon.svg" width=100></a>| |---|---|---|---| |[GitHub Desktop](github-desktop-tutorial.md)|[Visual Studio 2017](github-windows-vs2017-tutorial.md)|[GitKraken](gitkraken-tutorial.md)|[Visual Studio Code](github-windows-vs-code-tutorial.md)| -## Self-Promotion +Alt Self-Promotion If you liked this project, star it on [GitHub](https://github.com/Roshanjossey/first-contributions). If you're feeling especially charitable, follow [Roshan](https://roshanjossey.github.io/) on