4. Dev Guidelines
Before you start working on an issue, please move the card in the project page to in-progress.
- Format: feature/issue-number-issue-name
- Example: feature/13-backend-test-setup
We mainly use two branches: main and develop. All the feature branches should always be updated with develop before creating pull-request. The main branch is for a test server, force merge and push are only available for Admin. Those who have access to Akvo DevOps Infra should be able to promote the main branch to production with a git tag, CLI will be available soon.
- Always include the issue number in your commit message so we could always track the progress of the assigned issue.
- Doing a commit and then pull while working in a team, always lead to merging conflicts. So make sure your branch is updated by doing
git pullbefore making a commit. - I did
git commitand found that my local branch, how to justify it? If you merge your local branch into the origin branch, there will be only a single commit reported on the origin branch you've merged even if your local branch has multiple commits, regardless of whether you use a plaingit pullor--squash merge. You should always dogit pull --rebaseinstead ofmerge. - Develop branch is the place where you create your pull-request
- Before creating pull-request, make sure you have
mergedorrebasedevelop branch to your branch
View in Github Issue
View in Zulip
Become friends with your broken builds. So, your build fails… what exactly does that mean? You can always check the pipeline build from https://akvo.semaphoreci.com/projects/rtmis. Checking the job output should point you to a failing test. There are several reasons:
- Build or Deploy code is an error, DevOps to blame.
- Network test is error. Meaning that there are missing URLs or the network/proxy is misconfigured.
- Backend or Frontend test is Failed
- Code Quality (Flake, ESLint, or Prettier) warning
Example Error
But Note that we shouldn't be afraid of this. We just need to fix it together!
We use https://dbdocs.io/docs/ci-integration, push a commit to the develop and the main branch will trigger dbml generation from the Django migration schema and sending an update to dbdocs.io page.
