Skip to content

Commit e80ab80

Browse files
committed
fix: reviewer's finding
1 parent 397a9e2 commit e80ab80

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,8 @@ The desktop app uses [pywebview](https://pywebview.flowrl.com/) to render the Fl
242242

243243
## Versioning
244244

245+
> **Merge note:** The full policy and `CHANGELOG.md` ship in [PR #85](https://github.com/cppalliance/cppa-cursor-browser/pull/85) (#74). Land that PR with or before this one to avoid duplicate or dead links.
246+
245247
This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) (`MAJOR.MINOR.PATCH`).
246248

247249
**Pre-1.0 stability (current):** The project is at `0.x.y`. During this phase:
@@ -260,7 +262,7 @@ This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
260262

261263
Adding new optional fields to JSON responses, adding new CLI flags with sensible defaults, or adding new export-format sections are *not* considered breaking.
262264

263-
A complete history of changes is maintained in **[CHANGELOG.md](CHANGELOG.md)** following the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
265+
Notable changes will be documented in **[CHANGELOG.md](CHANGELOG.md)** following the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format (see #74 / PR #85).
264266

265267
When an API surface is scheduled for removal, follow the process in **[docs/API_DEPRECATION.md](docs/API_DEPRECATION.md)** (response headers, changelog entries, minimum notice period).
266268

docs/API_DEPRECATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ While the project is at `0.x.y`, **breaking changes may land in any minor releas
1111
When an endpoint, parameter, response field, or CLI flag is scheduled for removal:
1212

1313
1. **CHANGELOG** — Add an entry under `### Deprecated` naming the surface, its replacement (if any), and the planned removal version.
14-
2. **Response headers** — Deprecated HTTP endpoints and parameters emit a `Deprecation` header on every affected response (see [Header format](#header-format)).
14+
2. **Response headers** — Deprecated HTTP endpoints and parameters emit a `Deprecation` header on every affected response (see [Header format](#header-format)). When the first endpoint is deprecated, implement this via a small shared Flask helper so handlers stay consistent with the policy.
1515
3. **Server log** — Route handlers log `logging.warning()` with the deprecated symbol and recommended replacement.
1616
4. **Removal** — Remove no earlier than **one minor version** after the deprecation was announced (e.g. deprecated in `1.2.0`, removable from `1.3.0`). Document under `### Removed` in the changelog.
1717

0 commit comments

Comments
 (0)