Skip to content

Git

Git is way to organize your code and reason about historical changes that has happened to the codebase. Technically, its a "version control system" (vcs) tool. There are many vcs tools available, but we use Git and host all our repositories in GitHub.

General Process

  1. You checkout from main to your own branch. Your branch should be prefixed with your initials, for example ms/sprint-fixes.
  2. You regularly pull from source branch into your branch using git pull origin main --no-rebase, resolve conflicts and commit it.
  3. You can commit frequently to your branch and keep pushing to remote.
  4. In general practice present continuous tense for branch names and commit messages. Examples for branch names ms/are fixes-iteration-1 , ms/adds-wallet-feature etc. Examples for commit messages are adds wallet feature, fixes copy mistake in home page, introduces feature toggle to view transactions page etc.
  5. You add pull request to the main branch and get it reviewed, implement feedback and get it merged.
  6. All the PRs should be squash merged to keep the main line history clean.
  7. You checkout to main branch, git pull and then branch out to your work branch. Repat steps #1

Github Workflows

Github workflows provide necessary hooks to ensure consistency of code repository through their workflows. Here are some of the important workflows we must follow

  1. Repository settings should ensure that delete head branches is checked.
  2. main branch should be added to protected branches and only PRs should be allowed to commit to main. If necessary uncheck admin overrides as well.
  3. PRs setting should have only squash and merge option checked, rest of the options like rebase, merge commit should be un checked.
  4. Ensure that PRs have a PR template and a reviewer to your PR is assigned.
  5. Use github workflows to run lint checks, builds and tests, if they fail, the PR should not provide merge option.
  6. Use github workflows to automate important things on the PR like test coverage, failures, deploy previews urls etc as a bot comment.
  7. Use environments to setup different deployment targets and use workflow actions to run deployments via actions trigger to particular environments. Each environment can maintain their own set of variables.
  8. Connect github repository to slack channel and involve collaboration with team.

Leverage workflows as much as possible to automate day to routine tasks.