Skip to content

Commit e8f1b3c

Browse files
committed
Decision 4: use a CHANGELOG
1 parent 1f004e6 commit e8f1b3c

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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 1.0.0].
6+
7+
## [Unreleased]
8+
9+
[unreleased]: TODO
10+
[keep a changelog 1.0.0]: https://keepachangelog.com/en/1.0.0/
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# 4. Use a changelog for tracking changes in each release
2+
3+
Date: 2025-09-03
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
Documenting changes for a release can be challenging. It often involves reading
12+
back through commit messages and PRs, looking for and classifying changes, which
13+
is a time consuming and error prone process.
14+
15+
## Decision
16+
17+
We will use a changelog (`CHANGELOG.md`) in the
18+
[Keep a Changelog 1.0.0][] format to be updated when code changes happen,
19+
rather than at release time.
20+
21+
## Consequences
22+
23+
This will make compiling releases much simpler, as the process for determining
24+
changes in a release is simply a matter of looking at the changelog.
25+
26+
This does add some overhead to making code changes, and requires that releases
27+
update the changelog as part of their process, but those overheads are small.
28+
29+
[Keep a Changelog 1.0.0]:
30+
https://keepachangelog.com/en/1.0.0/

0 commit comments

Comments
 (0)