search

AllYarnsAreBeautiful / ayab-desktop

The AYAB Software
http://ayab-knitting.com
GNU General Public License v3.0
61 stars 31 forks source link

Start using conventional commits #569

Open dl1com opened 1 year ago

dl1com commented 1 year ago

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.

t0mpr1c3 commented 1 year ago

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.

t0mpr1c3 commented 1 year ago

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.