Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

56 lines (42 loc) · 1.74 KB

Contributing Guide

  • The tab indentation size is 4 (whitespaces) for this project.
  • We use PyQt5 for building the GUI.

Steps to land a successful PR

  1. Fork the repository to your personal GitHub account. We call this forked repo as <YOUR_USERNAME>/EmotionGUI-UoA repo.

  2. Now, clone <YOUR_USERNAME>/EmotionGUI-UoA and add kaustubh-s1/EmotionGUI-UoA as the upstream:

    git clone https://github.com/<YOUR_USERNAME>/EmotionGUI-UoA.git
cd EmotionGUI-UoA
git remote add upstream https://github.com/kaustubh-s1/EmotionGUI-UoA.git
git fetch upstream

  3. Checkout to local's main branch. And create a new branch with the name of your feature (eg. docs):

    git checkout main
git pull upstream main
git push origin main
git checkout -b <FEATURE_NAME>

  4. 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>"

  5. Commit your progress if you haven't already and push it to <YOUR_USERNAME>:<FEATURE_NAME> likewise:

    git push origin <FEATURE_NAME>

  6. Open your browser and go to <YOUR_USERNAME>/EmotionGUI-UoA repo on GitHub.

  7. Create a PR from <YOUR_USERNAME>:<FEATURE_NAME> to kaustubh-s1:main (Very important step)

  8. Wait for the maintainer to review your code. If you need to make some changes, commit and push to <YOUR_USERNAME>:<FEATURE_NAME>.

  9. 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>

  10. Repeat from step 3 for a new PR.

And you're done!