6 Project history
Project history - Changelog
A changelog is a plain text file that contains a record of what notable changes are made between versions of software.
The keep a changelog website provides a detailed explanation of what a change log is.
Guiding Principles
Changelogs are for humans, not machines.
There should be an entry for every single version.
The same types of changes should be grouped.
Versions and sections should be linkable.
The latest version comes first.
The release date of each version is displayed.
Mention whether you follow Semantic Versioning.
Types of changes:
- Added for new features.
- Changed for changes in existing functionality.
- Deprecated for soon-to-be removed features.
- Removed for now removed features.
- Fixed for any bug fixes.
- Security in case of vulnerabilities.
Sources
Section 9.4, https://keepachangelog.com/en/1.1.0/
Project history - release notes
Project history -design choices
What were the decisions made in designing this hardware? Were other designs/options tried? please describe also what did not work.
Sources