keep-a-changelog
keep-a-changelog copied to clipboard
Adding authors
How would you recommend adding author(s)? Some releases are made by me, some are made by others and a third is a combination of several authors. I would really like to keep track of this in the changelog.
Should I just add an authors section and/or add the author for each change/addition/removal? Example: `
[1.1.0] - xxxx-xx-xx -------------------------------------------------------
Author
Added
- Pick released by
- Ship method [[email protected]]
- Pre-pack flag [[email protected]]
Changed
- Line date associoation. [[email protected]]
- Changelog format.
- Start following semantic versioning properly. [[email protected]] `
I feel like listing the author in each line of changes is sufficient. I don't think the Author section is usually very useful.
If seems like it'd be OK to have a paragraph at the top of the section for each version, with project-related announcements, calling out things like a new maintainer, or even thanking new authors joining in.