Ensure that you have a working development environment, instructions here. When doing development for the Vector Atlas system, you should use the following process:
- Select a story from the GitHub project board.
- Pull the latest version of the
mainbranch - Create a branch from there called
feature/{insert general name of story}-#{story number} - Put the story into
In Progresson the GitHub project board - Repeatedly during development:
- Develop code/write tests
- Ensure all tests pass
- Run linter and fix issues
- Commit
- (optionally) push to
origin
- Merge
origin/maininto your feature branch. - Run unit tests
- Check impact on coverage, write more tests if below threshold.
- Run any system tests if relevant.
- Push to
origin - Make a pull request
- Put the story into
In reviewon the GitHub project board - Get the pull request reviewed and address any comments
- Wait for the automated build on GitHub project to succeed
- Once a pull request is approved then it can be merged back into
origin/mainby completing the pull request. - Check that the merge build succeeded.
- Move the story to
In testingon the GitHub project board - If a bug is found in testing, move the story back to
In Progressand start the workflow again from Step 4. - If the code passes then it is a Tester's responsibility to move the story to
Done.