Contributing

Linting and Formatting

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-feature branch prefixed with dev/}
"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.

(one time) Login to npm via:
npm login
Create new branch for version bump.
Verify build is up-to-date:
npm run build:css
_{Commit substantial unexpected changes via independent PR.}
Update CHANGELOG.md.
Update version via:
npm version vN.N.N
(where N.N.N is the version tag)
Build with new version:
npm run build:css
Commit, push, PR, review, merge.
Publish to NPM via:
npm publish --access public
_{Project build will automatically occur before publish.}
Create release and tag on GitHub.
Fetch the latest tags.
git fetch --tags
Check whether tag is annotated.
git describe --always
(expect vN.N.N i.e. the version tag)
If tag is not annotated, then:
1. Annotate Github's tag:
  bin/annotate-tag.sh vN.N.N
  (where N.N.N is the version tag)
2. Overwrite remote tag with annotated one:
  git push --tags --force