search

conventional-changelog / conventional-changelog

Generate changelogs and release notes from a project's commit messages and metadata.
ISC License
7.85k stars 713 forks source link

confusing config property name `noteKeywords` #354

Open grubyak opened 6 years ago

grubyak commented 6 years ago

  1. release > generateNotes > parserOpts > noteKeywords used to indicate important notes (sets release type be major) is not self-describing - for example breakingChangeKeywords could be used instead

  2. documentation could be adjusted to inform that given keywords must appear at the beginning of the comment line

GirasolXimena commented 2 months ago

I agree! Needed this property for a project and only found out about it months later due to the confusing