Skip to content

Git Practices and Conventions

Jump to bottom
daltonlim edited this page Mar 14, 2020 · 12 revisions

Overview of Git workflow

The git workflow that we will be following can be found here. The general steps of this flow is as follows:

  • Fork and clone the main repository
  • Create a new feature branch every time you start work on a new issue.
  • Make your changes in the feature branch in your local clone. If the change is large, consider using a feature flag and multiple pull requests.
  • Update your local repository with the most recent code from the main repository. Remember to rebase often
  • Test your changes - run all existing tests and any new tests you have created, run the code and make sure the application works as expected.
  • Create a pull request. The pull request should follow the conventions set out here. The body should provide more details about what changes have been made and should reference the number of the associated issues, eg "Fixed synchronization issue closes #123". The tile of the pull request should not just reference the issue number - it should succintly describe the actual changes.
  • Another team member must review and approve of the pull request, we have set the minimum number of reviewers to 2 so make sure at least 2 members code review the pull request.
  • Once the reviewer approves the pull request, they can merge your contribution into the main repository. **Do not merge your own pull requests. **

Branch naming strategy

Feature branches should follow the convention of {issue-type}/{issue-number}-{issue-title} eg. If you have an issue which is a bug with number 30 and title Fix Headers your branch should be named bug/30-Fix-Headers. You should branch from latest version of master before starting (Most of the time, unless branching off a feature to extend its functionality or fix a bug etc).

Setting Up Remotes & Upstream

  1. Fork this repo to your account
  2. On terminal clone the fork to your computer via git clone <your repo>
  3. Set up upstream by git remote add upstream https://github.com/se701g2/Doto.git
  4. To make sure you don't accidentally push to your upstream, use this command: git remote set-url --push upstream no_push

Syncing with upstream and rebasing.

  1. Sync with the upstream using the following commands:
git fetch upstream
git checkout master
git merge upstream/master
  1. Once you have synced your master with upstream, run the following commands to rebase as opposed to merging.
git checkout <feature-branch>
git rebase master
Clone this wiki locally