Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 2.24 KB
Raw

Follow these steps to contribute

  1. Go to preferred folder in your computer and paste the following command after forking our repository (Only one of it if you don't have ssh setup then go with HTTP command)
git clone https://github.com/<YOUR-USERNAME>/Bon-Hack-tit.git
  1. Navigate to the project folder
cd Bon-Hack-tit/
  1. Install dependencies
npm i
  1. Now do ahead and create a new branch and move to the branch
git checkout -b fix-issue-<ISSUE-NUMBER>

Note: Replace <ISSUE-NUMBER> with the issue number you are working on

  1. Run in local
npm start

Add new features or fix bugs according to your issue number

  1. After done you can now push this changes, for doing that follow the following command chain

  • git status -s (Shows the changed files)

  • git add --all (Will add all the files to staging area)

  • git commit -m "feat/docs/fix: <EXPLAIN-YOUR_CHANGES>"

    Note: Replace <EXPLAIN-YOUR_CHANGES> with the changes you have made. Also, follow the conventional commits for writing commit messages

  • git remote add upstream https://github.com/coder12git/Bon-Hack-tit.git

  • git push origin fix-issue-<ISSUE-NUMBER>

  1. After this go to your forked GitHub repository and go to Pull Request section. Now you might be able to see a pop up saying Pull Request. Click on the popup and you will be redirected to pull request page

  2. Now fill in the form template of the pull request and give the necessary description.

  3. Click on Submit

  4. Hurray! You just made your first contribution to this project 🎉

  5. Wait for your pull request to be reviewed and merged.

Useful Links