Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 4.89 KB

HowToContribute.md

File metadata and controls

78 lines (59 loc) · 4.89 KB

###Guidelines

**After going through the steps given below you will be able to understand how to contribute to this project. **

  • Step 1 For open-source contribution, all you need is a version control software like git which keeps track of all the states(assume it as version) of a project. Git can be downloaded by following the link - https://git-scm.com/download/win image

  • Step 2 After installing git all you need a project to contribute. image

  • Step 3 Now all you need to do is to clone that repo locally into your pc and work on it. To clone a repo from GitHub all you need to do is to fork that repo in your own Github account. It gives you freedom to work on the project anytime anywhere. For this you just need to click Fork . image

  • Step 3 After forking , you'll need to clone it locally on your pc. To clone a project locally on your pc, all you need to copy the repo link (the forked version in your own Github account) which you can find after clicking on the code icon. image

  • Step 4 Now move on to your local environment and open a folder, for example here I am using VS, code editor because it has an inbuilt terminal that helps us to run git commands along with the editor functionality. image

  • Step 4 Type commantd git clone repository link in the terminal (repo link of your forked version). image

Now you see the chords folder.This is where the project lies. Now , you need to chnage directory to that particular folder image

  • Step 5 Now , you have to set an upstream to the parent repo so that we can get an updated version of the project anytime. Type command git remote add upstream parent repository link . image

copy the link

Now , to get an updated version locally, Type command git pull upstream main image

After following all the steps mentioned above , your local environment should look like this.You can see you the updated version of the project.

image

######You are up now to contribute.

  • Step 6 It is adviced to create a branch to fix the bugs or add features.The new branch will have all the codes from the main branch.
- Type command git branch branch_name to create branch.
- Type command git checkout branch_nameto enter in that branch

image

- You can always check the current branch you are working in by command git branch

image

  • (*) Shows the active branch

  • Step 7 Fix the bug

  • Step 8 Stage and commit your changes before you push them.

  • Type git add . to stage the files first.
  • Type git commit -m "Typo error fixed(message)" to commit. image
  • Step 9 Now, push the changes to the repository.

Type command git push origin branch_name

image

  • Step 10 So, you can request the project administrator to review the changes and add them to the main repo of the project. So, you have to create a pull request for the project administrator. Create a pull request, by clicking compare and pull request. image

Now, the project administrator would be able to review the pull request and can merge it into the main branch.

Make sure that whenever you are working on a bug, it(bug) should be there in the updated version, there might be a possibility that someone else has fixed the bug in the updated version.Do not waste your time

#Congratulations! ###You are all set to become a contributor.