jambor.pro/docs-onboarding
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update: Guidlines and test script for git commit based release notes

Browse source
This commit is contained in:
Jan 2024-05-13 09:46:03 +02:00
parent caa4513920
commit ed117d6195
2 changed files with 38 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

8
documentation-guidelines.md
View file

@ -7,9 +7,11 @@ Best practices and guidelines for writing code documentation.
The idea is to get rather automated release notes. To have this as easy as possible, we need:
- key words for the kind of change we applied:
- `feature:` - for newly added functionality
- `fix:` - for bugfixes
- `nonotes:` - for git commits we don't want to see in the release notes
- `new:` - for newly added functionality
- `update:` - for updated functionality
- `fix:` - for fixed functionality
- `delete:` - for removed functionality
- Everything else will be ignored
- tags for each version, we will output only the change log from the last and second last tag
- you can add tags with `git tag -a <tag> -m "<message>"`