Development Guidelines

Development Guidelines

This document will server as a holy grail for avoiding as many merge conflicts and incorrect merges as well as standardize the procedure to collaborate. Below are a few rules that should be followed while working together on the ASCT+B Reporter.

1. Never push to main. All new features/bug fixes should be targeted toward develop. Only when code is approved, should it be pushed to master for production.
2. While working on the feature branch, remember to always rebase with develop. This will avoid future conflicts with the code (and maybe bugs with your current feature branch).

   # How to rebase (in short)
   $ git checkout <branch_name>
   $ git rebase -i origin/develop
   $ git rebase --continue # if there are conflicts, solve them and then run this
   $ git add .
   $ git commit -m 'chore: rebase with develop'

3. Use meaningful commit messages. Prefix the commit message with either of the following, depending on your task:
   • chore: If implementing somethign new or adding onto some feature. (git commit -m 'chore: implemented compare sheets feature')
   • fix: If fixing a bug or a related issue. (git commit -m 'fix: issue with the drop down menu options')
   • style: If adding documentation or linting changes to the code. (git commit -m 'style: added comments to the tree service')
4. After pushing a new branch that contains a bug fix/ feature etc,
   • Review your code before pushing it
   • Make a pull request
   • Add a small title/description for the PR
   • Assign yourself (or other members of the team)
   • Add reviewers
   • Add a suitable tag