- Are you new to open source project?
- Do you want to make open source contribution?
- Can't find a beginner's project to contribute to?
This is simple project you just have to add yourself as contributor by adding your name in members.json
file.
Don't worry below is step by step guide to help you make your first contribution!
Here you will learn how you can contribute to this project and can make your first contribution
You can fork this repository by clicking on fork button on top right corner. Once you fork this will create a copy of repo on your account
To clone the repository go to your account, open this repo and either click on clone button or run the command below to get this repository on your local machine.
git clone "URL you just copied"
e.g. git clone https://github.com/yourgithubusername/first_contribution.git
On your local machine go the project folder that you cloned and use following git
command inside that folder
Create a new branch using below command:
git checkout -b <add-your-github-username>
e.g. git checkout -b add-owais431
On your local machine open Data
folder in repository and change member.json
file and add your details in contributors array.
Now we have to add changes that we made to the branch so for that we will run following command:
git add Data/member.json
Now we have to commit changes, commit message should always be clear, to commit use command below:
git commit -m "Add my-name to the list of contributors"
Now we have to push the changes that we made to remote repository on specified branch to do so use command below
git push origin name-of-your-branch
Name of branch is same as you created in step 3
Once you have pushed your code to GitHub, now it's time to create a pull request
, you will go to the repository click on compare and pull request
and submit the pull request.
Soon, we will be merging all your pull requests to the main branch of project and you will also get notification once your pull request is merged with existing code base. After that you will be able to see your details in contributor section on the page below.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!