- The tab indentation size is 4 (whitespaces) for this project.
- We use MERN stack for the project.
- The
/client
folder is the main directory for Create React App. - The
/server
folder is the main directory for the express server (backend).
-
Fork the repository to your personal GitHub account. We call this forked repo as
<YOUR_USERNAME>/tap
repo. -
Now, clone
<YOUR_USERNAME>/tap
and addhouseofgeeks/tap
as the upstream:git clone https://github.com/<YOUR_USERNAME>/tap.git cd tap git remote add upstream https://github.com/houseofgeeks/tap.git git fetch upstream
-
Checkout to local's
dev
branch. And create a new branch with the name of your feature (eg.docs
):git checkout dev git pull upstream dev git push origin dev git checkout -b <FEATURE_NAME>
-
Close the terminal and complete the task. You may commit your progress as many times as you like during the process:
git add --all git commit -m "<YOUR_MESSAGE>"
-
Commit your progress if you haven't already and push it to
<YOUR_USERNAME>:<FEATURE_NAME>
likewise:git push origin <FEATURE_NAME>
-
Open your browser and go to
<YOUR_USERNAME>/tap
repo on GitHub. -
Create a PR from
<YOUR_USERNAME>:<FEATURE_NAME>
tohouseofgeeks:dev
(Very important step) This should look something like this: -
Wait for the maintainer to review your code. If you need to make some changes, commit and push to
<YOUR_USERNAME>:<FEATURE_NAME>
. -
Delete
<YOUR_USERNAME>:<FEATURE_NAME>
branch after the PR is merged or is out of scope.git checkout dev git push -d origin <FEATURE_NAME> git branch -d <FEATURE_NAME>
-
Repeat from step 3 for a new PR.
And you're done!
Please note we have a Code of Conduct , please follow it in all your interactions with the project.