Please use Conventional Commits #38
Description
Whenever committing, please use the commit convention in:
https://www.conventionalcommits.org/en/v1.0.0/
or
https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13
Allowed types:
Type
Must be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
Special for orGUI - a physics software:
Important scopes to be used:
- phys : anything related to the physics: math, error propagation etc. Whenever a change can affect the measurement result (counters, error estimation, ...), this scope must be used! I will add a specific section for these changes in the changelog.
A BREAKING CHANGE (!) is not just a change that affects orGUI, but also any other postprocessing scripts that might use the data generated by orGUI.
BREAKING CHANGEs are signified with the exclamation mark symbol ! and should have a longer description like:
feat!: remove ticket list endpoint
refers to JIRA-1337
BREAKING CHANGE: ticket endpoints no longer supports list all entities.
Example
feat(phys): add systematic error estimation
This would mean that a new physics feature was added.
or
fix(phys)!: fix number of data points in calculation of systematic error
This would mean that a bug in the physics calculations was fixed. And this change is BREAKING the old code, which is signified with the exclamation mark symbol !, since this change will break old scripts that use this data.
Other examples
From now on for releases:
build(release): bump version to 1.0.0