Skip to content

Commit 080cfcb

Browse files
committed
docs: add CHANGELOG.md
1 parent 4e4418e commit 080cfcb

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- Future features and improvements will be listed here
12+
13+
### Changed
14+
- Ongoing updates and modifications
15+
16+
### Fixed
17+
- Bug fixes and corrections
18+
19+
---
20+
21+
## How to Update This Changelog
22+
23+
When making changes, add an entry under `[Unreleased]` in the appropriate category:
24+
25+
- **Added** – new features
26+
- **Changed** – changes to existing functionality
27+
- **Deprecated** – soon-to-be removed features
28+
- **Removed** – removed features
29+
- **Fixed** – bug fixes
30+
- **Security** – vulnerability fixes
31+
32+
When releasing, change `[Unreleased]` to the version number and date,
33+
then add a new empty `[Unreleased]` section at the top.
34+
35+
---
36+
*Documentation contributed by [Mukller](https://github.com/Mukller)*

0 commit comments

Comments
 (0)