|
| 1 | +# Let's contribute in the simplest way possible. |
| 2 | + |
| 3 | +Let's make a simple contribution to this repository. |
| 4 | + |
| 5 | +Let me show you how easy it is: |
| 6 | + |
| 7 | +## 1. Fork this repository |
| 8 | + |
| 9 | +Fork this repository by clicking on the fork button on the top of this page. |
| 10 | +This will create a copy of this repository in your account. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## 2. Clone the repository |
| 15 | + |
| 16 | +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. |
| 17 | +Now let's bring the cloned repository to your local machine. |
| 18 | +`git clone <url-you-just-copied>` |
| 19 | +For example: |
| 20 | +` git clone https://github.com/CodeMacrocosm/startup.git` |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +## 3. Move inside the repository |
| 25 | + |
| 26 | +Since you want to change the files inside, first let's move to the folder correctly. Use the following command on terminal: |
| 27 | +`cd startup` |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## 4. Make a new branch |
| 32 | + |
| 33 | +Since now you're about to make your personal changes to the project, it's always a better idea to make a new branch. Run the following command: |
| 34 | + |
| 35 | +`git checkout -b <feat-add-yourname>` |
| 36 | +For example: |
| 37 | +`git checkout -b feat-add-5hre9a` |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## 5. Make the required changes |
| 42 | + |
| 43 | +Check out the [CONTRIBUTE.md](/contribute.md) file to see what all contributions can you make. |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## 6. Commit all your changes |
| 48 | + |
| 49 | +It's finally that time when you commit your changes and leave a beautiful commit message behind. You can run the following commands: |
| 50 | + |
| 51 | +`git add .` |
| 52 | +`git commit -m "<Your Message>"` |
| 53 | +For example: |
| 54 | +`git commit -m "Added 5hre9a's Story"` |
| 55 | + |
| 56 | +Finally, push your changes to Github: |
| 57 | +To do so run the following command: |
| 58 | + |
| 59 | +`git push origin <your-branch-name>` |
| 60 | +For example: |
| 61 | +`git push origin feat-add-5hre9a` |
| 62 | + |
| 63 | +--- |
| 64 | + |
| 65 | +## 7. Hit me a pull request |
| 66 | + |
| 67 | +If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button. |
| 68 | +Now submit the pull request. Leave a custom message if you want. |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +# Motivation |
| 73 | + |
| 74 | +There seems to be a lot of hype. Contributing to Open Source can be a highly satisfying experience, especially for new developers out there who have just started with their journey. |
| 75 | + |
| 76 | +How will this work: |
| 77 | +You get your PR's done and contribute to a cool repository by sharing your stories and struggles and helping others in their journey. |
| 78 | + |
| 79 | +Happy Coding. Hope you all get your cool swags :) |
0 commit comments