- Thinking about doing an open source contribution?
- Don't know where to start or how to do?
- Looking for a simple repository to help you to get started?
Then look no further, we have created this repository to help you to get started.
If you don't have git installed in your machine, install it.
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.
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.
Open a terminal and run the following git command:
git clone "URL you just copied"
For example:
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.
Change to the repository directory on your computer (if you are not already there):
cd first-contributions
Now create a branch using the git checkout command:
git checkout -b <add-your-new-branch-name>
For example:
git checkout -b add-muhammad
(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.)
Now open contributions.yml file from _data directory in a text editor, add your name with emoji of your country flag, github_account and profile picture URL (avatar) to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.
If you go to the project directory and execute the command git status, you'll see there are changes.
Add those changes to the branch you just created using the git add command:
git add _data/contributions.yml
Now commit those changes using the git commit command:
git commit -m "Add <your-name> to Contributors list"
replace <your-name> with your name.
Push your changes using the command git push:
git push origin <add-your-branch-name>
replace <add-your-branch-name> with the name of the branch you created earlier.
Now if you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.
Now submit the pull request.
Soon, I'll be merging all your pull requests into the master branch of this project. You will get a notification email once the changes have been merged.
Thank you to all the contributors who help in making this project better 🙌