How to Contribute

Linting and Formatting

GitHub will run linting and formatting check.

To automatically fix what it finds, run npx nx format:write.

We use a modifed version of GitFlow.

"feature branches" have a specific prefix:
- feat/ for features and updates
- fix/ for bugfixes and hotfixes
- refactor/ for large internal changes
- style/ for code style changes (white-space, formatting, etc.)
- chore/ for no-op changes
- docs/ for documentation
- perf/ for performance improvements
- test/ for test case updates
- or other "types" from Conventional Commits
"develop" branch is usually main,
^{but can exist as a long-lived multi-task branch}
"release branches" (as needed) are prefixed with release/
"hotfix branches" are prefixed fix/
"master branch" is always main

Only appointed team members may release versions.

Create release or pre-release and tag on GitHub.

type	use case	tag format	example
release	deploy to prod.	`vA.B.C` following SemVer	`v1.1.3`
pre-release	deploy to dev.	`vA.B.C-YYYYMM-ZZ` _{Where ZZ is the number of pre-releases since vA.B.C.}	`v1.1.3-202312-03` _{Where 03 is the third pre-release of December.}