🚀🌟 The intention of this project is to help you understand how to contribute to any project on GitHub and kick-start your open source contribution journey with Hacktoberfest. You will learn this by adding yourself onto this project's contributors list.
Hacktoberfest is a month-long celebration of open source software run by DigitalOcean and DEV. You can win a free T-shirt 👕 if you complete 4 PRs (Pull Requests). For more information and registration, check here.
GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere. If it gets a bit overwhelming at first, we recommend you to check this.
IMPORTANT: MAKE SURE THAT YOU HAVE REGISTERED YOUR GITHUB PROFILE WITH HACKTOBERFEST (HERE) BEFORE PROCEEDING.
Any type of contribution involves these basic steps:
- Forking
- Making Changes
- Committing changes (to fork)
- Pull Request (PR)
- Merging
Complex contributions may also involve: Cloning, and Branching. For the sake of simplicity, we won't be covering cloning and making local changes in this tutorial.
- A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
- To fork a project, click on the 'Fork' icon at the top right. A copy of this project will be created in your profile.
- We will be editing the 'README.MD' file using GitHub to add your name onto the contributors list.
- Select the README.MD file from project files list and select the EDIT icon.
- Scroll down and add your name onto the end of contributors list in a new line using this format:
* [your-username](https://www.github.com/your-username) <any-three-emojis>
- You are asked to add any 3 emojis that you may find interesting/really like/feel that describe you. Check this link to search and copy-paste emojis or this for GitHub-standard emojis.
- .MD files use MARKDOWN markup language to format the text. For a cheat sheet, check this.
- Scroll down to the 'Commit changes' pane.
- Type a title for your commit.
- Click on the 'Commit changes' button.
- The changes that you've made have been committed to your fork.
- A 'Pull Request' is essentially a request to the author of the original repository to accept the changes you've made to your fork.
- Start by heading to the original repository (basic-contributions).
- To the right of the Branch menu, click 'New pull request'.
- On the Compare page, click 'compare across forks'.
- Confirm that the base fork (the one on the left) is the repository you'd like to merge changes into.
- Select your fork on the right.
- Type a title for your pull request like 'add(user):your-username'.
- Select 'Create Pull Request'.
- Merging your changes to the master fork is done by the owner.
- So, wait it out, and congratulations on making your first PR!
Check issues marked with "good first issue" to find projects need your help!