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

update: Move chapter release Notes to Versioning part of the documentation.

Browse source
This commit is contained in:
Jan Jambor 2024-05-30 22:03:19 +02:00
parent 2fd9f69d47
commit 5b84397754
2 changed files with 3 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

5
versioning.md
View file

@ -53,8 +53,9 @@ The idea is to get rather automated release notes. To have this as easy as possi
- `delete:` - for removed functionality
- Everything else will be ignored
- A git commit example for a new feature: `git commit -m "new: added new feature"`
- A git commit example for something you don't want to show in the release notes (omit any of the keywords at the beginning): `git commit -m "updated readme"`
- A git commit example for a new feature: `git commit -m "new: added new feature"`.
- A git commit example for something you don't want to show in the release notes (omit any of the keywords at the beginning): `git commit -m "updated readme"`.
- In general, write meaningful commit messages. Avoid generic stuff like "new version", "updated readme", "enhanced wording" etc. Try to put yourself in the shoes of someone who has to understand what you did without looking at the whole code or document.
[resources/scripts/release-notes.bash](resources/scripts/release-notes.bash) is an example bash script to generate the release notes. You can run it with the following command: