Skip to content
  • Jan Girlich's avatar
    new: Use gitchangelog to directly use commit messages for CHANGELOG generation · 1adac2ee
    Jan Girlich authored
    A short excerpt from the gitchangelog documentation about how to format the commit messages:
    
    Format
    
      ACTION: [AUDIENCE:] COMMIT_MSG [!TAG ...]
    
    Description
    
      ACTION is one of 'chg', 'fix', 'new'
    
          Is WHAT the change is about.
    
          'chg' is for refactor, small improvement, cosmetic changes...
          'fix' is for bug fixes
          'new' is for new features, big improvement
    
      AUDIENCE is optional and one of 'dev', 'usr', 'pkg', 'test', 'doc'
    
          Is WHO is concerned by the change.
    
          'dev'  is for developpers (API changes, refactors...)
          'usr'  is for final users (UI changes)
          'pkg'  is for packagers   (packaging changes)
          'test' is for testers     (test only related changes)
          'doc'  is for doc guys    (doc only changes)
    
      COMMIT_MSG is ... well ... the commit message itself.
    
      TAGs are additionnal adjective as 'refactor' 'minor' 'cosmetic'
    
          They are preceded with a '!' or a '@' (prefer t...
    1adac2ee