AllYarnsAreBeautiful/ayab-desktop

Start using conventional commits

Opened this issue · 2 comments

dl1com commented

I propose to add the usage of conventional commits acc. to https://www.conventionalcommits.org/en/v1.0.0/ to our contribution guideline.
No hard enforcement, but would be nice to have them i.e. to generate release notes automatically in the future.

Could be useful to auto-generate CHANGELOG once we have semantic versioning.

Currently I have been trying to follow https://keepachangelog.com/en/1.1.0/ which standardizes changes by categorizing them as:
Added - for new features.
Changed - for changes in existing functionality.
Deprecated - for soon-to-be removed features.
Removed - for now removed features.
Fixed - for any bug fixes.
Security - in case of vulnerabilities.

I also try to mark commits based on whether they impact the GUI, engine, devops, docs etc.

Slightly off topic Chris, but do you keep a note somewhere of all the organizational tasks you do to keep AYAB running? It might be useful for future purposes to write them down somewhere.