As @AranVink suggested here, add a CONTRIBUTING.md file to this project, laying out some expected conventions and best practices, including commit messages that conform to the Conventional Commits conventions.
The reason for that being that the automatic changelog generator that is triggered on each release will use the Conventional Commits prefixes to categorize all the notes under separate lists, for increased clarity.
But we might want to establish some other conventions and best practices in this file as well.
volkertb
commented
3 months ago
As @AranVink suggested here, add a
CONTRIBUTING.mdfile to this project, laying out some expected conventions and best practices, including commit messages that conform to the Conventional Commits conventions.The reason for that being that the automatic changelog generator that is triggered on each release will use the Conventional Commits prefixes to categorize all the notes under separate lists, for increased clarity.
But we might want to establish some other conventions and best practices in this file as well.
For more info in the GitHub documentation here.
An example template for such a file can be found here.