Skip to content

Latest commit

 

History

History
executable file
·
66 lines (59 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
66 lines (59 loc) · 2.77 KB

Contributing to Eggventory

Note: Pull requests are welcome. For making major changes, please create an issue to first discuss the changes and then add them. Please make sure you add appropriate test cases for your major commits to the repo.

Prerequisites

  • Familiarize yourself with git commands
  • Fork the group repository into your personal GitHub account
  • Set up this project in IntellijIDEA
  • Familiarize yourself with gradle and Travis CI
  • Be well aware of the project scope and constraints

Definitions

Main repository: Our group's repository (AY1920S1-CS2113T-F09-3/main)

Your fork: Your fork of the group's repository

Setup

Note: The steps provided here follow git CLI commands. If you are using Git GUIs like Source Tree, please make sure you follow steps that are equivalent to these commands.

  1. Clone your fork into your computer.
git clone 'your fork address'
  1. Add the main repository as upstream
git remote add upstream 'your main repo address'

Workflow

Note: Dont push any commits directly to the the master of the main repository.

  1. Your work must address an open issue.
  2. Pull from upstream into your local repository's master.
git checkout master
git pull upstream master
  1. Create a branch from master and checkout to that branch
git checkout -b your-branch-name
  1. Add/delete/append the files that you want to. Remember to commit at regular intervals with proper commit messages.
  2. After finishing your work, merge your branch with upstream master.
git checkout your-branch-name
git fetch upstream master
git merge upstream/master
  1. Push your local branch to your fork
git push origin your-branch-name
  1. Go to GitHub. Locate your branch in your fork and create a pull request from it to the main repository master.
  2. Label your pull request appropriately.
  3. Your code would be automatically tested by Travis CI for errors.
  4. Add reviewers and wait for their reviews.
  5. If your pull request fails, dont close it. Just repeat steps 4 to 6.
  6. Else if you are pull request is approved, squash and merge. Again, write proper messages for the same.
  7. Tag your work done if required
git tag <extension>
  1. Push the tags to main repository.
git push upstream --tags

Adapted from Mohideen Imran Khan's CONTRIBUTING.md