We use GitHub Projects as a Kanban board and integrate the GitHub Issues feature to track the progress of tasks and related pull requests – remember to link the issue to the Kanban board.
Include the following information when reporting an issue (where possible):
- Breakdown of the problem/specification of expected changes
- Reproducible steps (if reporting a bug)
The high priority label should be sparingly to avoid diluting its
significance – overuse of this defeats the purpose of the label.
Include the following information when submitting a pull request:
- Overview of the changes
- Where needed, add explanations about what the changes will effect and why they were made.
- Related issues
- Using the
Fixes {link to issue}syntax will automatically close the issue once merged.
- Using the
After pushing to the repository, the workflow in GitHub Actions consists of:
- Running code formatting with Prettier
- This ensures good readability and a consistent style across the codebase to reduce diffs for code reviews.
We follow the Google style guides, as these are most commonly used in the web development community: