All notable changes to the project MUST be documented in this file.
The format can be based on Keep a Changelog and the project versioning could adher to Semantic Versioning.
- 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.
- 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 vulnerabilitie
Here we write upgrading notes for brands. It's a team effort to make them as straightforward as possible.
- PROJECTNAME-XXXX MINOR Ticket title goes here.
- PROJECTNAME-YYYY PATCH Ticket title goes here.
Here we would have the update steps for 1.2.4 for people to follow.
- PROJECTNAME-ZZZZ PATCH Drupal.org is now used for composer.
- PROJECTNAME-TTTT PATCH Add logic to runsheet teaser delete to delete corresponding schedule cards.
- PROJECTNAME-UUUU MINOR Fix module foo tests
- PROJECTNAME-RRRR MAJOR Module foo's timeline uses the browser timezone for date resolution