Making your first Open Source Contribution
- Get ready!
- Create a Github account if you haven't already. Link: https://github.com/join
- Create an issue in this repository saying something like "Add YOUR_NAME_HERE to the contributors."
- Comment below the issue if you're willing to work on it.
- Wait for a maintainer to assign the issue to you.
- Meanwhile, fork this repository using the fork button.
- Install and setup git in your machine, if you haven't already. You can follow the instructions given here
- Clone this repository.
git clone https://github.com/satwikkansal/oss_first_contribution.git
- Check into the directory
- Add remote to your fork
Click the green clone button on your repository to find out the "your_fork_url"
git remote add myfork your_fork_url
- Look for the file "Contributors.md" in the directory. Open it in any editor (notepad, sublime, vim, nano, etc) and just add your name to the end of the file.
- Check your modifications with
- Add the file to staging
git add Contributors.md
- Commit your changes.
PS: Replace YOUR_NAME_HERE with your own lovely name.
git commit -m "Add YOUR_NAME_HERE to the contributors. Yay!"
- Push your changes to github
git push myfork master
- Open your forked repository on Github, click on the "Create a Pull Request Button", and submit a Pull Request (don't forget to add the url of the issue you created in the PR description).
- Now sit back and relax! Some maintainer will merge you PR soon. And voila, you just made your first contribution!!
- Once your PR is merged, feel free to close the issue you created.
- It would be great if you could spare 30 seconds of your time to fill out this feedback form (It helps a lot!) - http://bit.ly/ossdtu1
Note: If you are stuck at any step, feel free to open up an issue in this repository describing your problem.
Finally, you're all welcome to join our Facebook discussion group DTU : Open Source Software Development (SIG) and ask your queries or share your achievements (like your first contribution :P).
Now feel free to play around with Github, follow your friends, check out different project, see what's trending and so on.. Remember, the more you explore on your own, the better you'll learn.