Software packages are often shipped with changelog and/or release notes. What's the difference between them? Should they be both included with release of a new version?
Difference between release notes and changelog
releaserelease-managementsoftware-distributionversion control
Related Topic
- Git for beginners: The definitive practical guide
- Git: How to force “git pull” to overwrite local files
- Git – What’s the difference between git reset –mixed, –soft, and –hard
- I’ve found the software as cracked download on Internet, what to do
- Git – What’s the difference between HEAD, working tree and index, in Git
- Git – Warning: push.default is unset; its implicit value is changing in Git 2.0
- Using IPython notebooks under version control
- Node.js – Do I commit the package-lock.json file created by npm 5
Best Answer
To directly answer your question, you can include both in your software release.
Release notes are a set of documents delivered to customers with the intent to provide a verbose description of the release of a new version of a product or service. These artifacts are generally created by a marketing team or product owner and contain feature summaries, bug fixes, use cases, and other support material. The release notes are used as a quick guide to what changed outside of the user documentation.
Conversely, changelogs are comprehensive lists of the new features, enhancements, bugs, and other changes in reverse chronological order. Changelogs usually link to specific issues or feature requests within a change management system and also may include links to the developer who supplied the change.