forked from apps/featurer
Basic project-related files.
This commit is contained in:
28
CHANGELOG.md
Normal file
28
CHANGELOG.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## In short
|
||||
|
||||
Version should be level 2 header in format `[VERSION_NUMBER] - YYYY-MM-DD`.
|
||||
|
||||
Place these in level 3 headers for appropriate version:
|
||||
|
||||
- `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.
|
||||
|
||||
In the very end of this file you should place links to diffs between versions, like:
|
||||
|
||||
```
|
||||
[0.0.4]: https://code.pztrn.name/apps/featurer/compare/v0.0.3...v0.0.4
|
||||
```
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
> [Unreleased]: https://code.pztrn.name/apps/featurer/compare/v0.0.1...main
|
||||
Reference in New Issue
Block a user