1.3 KiB
Development Workflow
Small Feature Development
Contributors who have write access to the repository will practice continuous delivery (CD as known from now on in this document).
We will define CD in this document as a method of developing a feature per commit with an encapsulating test that proves that the functionality is working, the contributor will test their code locally and if all is passing will push to master.
For contributors that do not have write access, follow the same conventions but open a Pull Request instead.
Large changesets
When larger changes need to be made, or the work that is carried out spans multiple components / services of the application at the same time a single commit will not suffice.
In this scenario, the contributor should open a pull request instead.
Commit messages
Follow Git blessed and Conventional Commits
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
Types:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test