From d482013cf7e36bd5f29d444d0a7fbb1953e071f7 Mon Sep 17 00:00:00 2001 From: poli0981 <127664709+poli0981@users.noreply.github.com> Date: Tue, 17 Nov 2026 08:59:55 +0700 Subject: [PATCH] docs: name changelog/ where CHANGELOG.md is named README's link, the export-ignore beside CHANGELOG.md's, the watch-paths note in DEPLOYMENT.md, and a CLAUDE.md rule for where release notes go and how a release moves [Unreleased] into its own file. Co-Authored-By: Claude Opus 5.5 --- .gitattributes | 1 + CLAUDE.md | 8 ++++++++ README.md | 2 +- docs/DEPLOYMENT.md | 2 +- 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.gitattributes b/.gitattributes index e88615dc..43931597 100644 --- a/.gitattributes +++ b/.gitattributes @@ -17,6 +17,7 @@ CONTRIBUTING.md export-ignore SECURITY.md export-ignore ACCESSIBILITY.md export-ignore CHANGELOG.md export-ignore +changelog/ export-ignore README.md export-ignore # The legal documents stay IN the archive: the web build reads all of them # (web/build/legal-versions.ts) and stops when one is missing. diff --git a/CLAUDE.md b/CLAUDE.md index ad7f18d9..15c609bf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -30,6 +30,14 @@ keep running; the code no longer grows. What that means for any change: file name, so renaming a form is a web change. - The policy is stated in `README.md` ("Project status"), `CONTRIBUTING.md`, `SECURITY.md` and the pull-request template: change them together. +- **Release notes are one file per release**: + `changelog/v/..x/.md`, and `changelog/beta/` + for a pre-release (none so far). `CHANGELOG.md` is the index, and keeps + `## [Unreleased]`, where every change writes its entry. A release moves that + section into its new file (headings one level up, relative links prefixed + `../../../`), adds its row to its major's table and empties [Unreleased]; + what the file says below its title and back link is the GitHub release's + notes. A released file is not reworded afterwards. - Every rule below still holds. Maintenance mode is when they matter most: the next change will be made by someone who has not touched the code for months. diff --git a/README.md b/README.md index 95927539..307dd540 100644 --- a/README.md +++ b/README.md @@ -290,7 +290,7 @@ Unemployed, introvert max level, dropped out uni year 3, mooching off family. Ne ### Docs - [AUTHORS](AUTHORS.md) — maintainer + canonical handle map + AI-assistant disclosure. -- [CHANGELOG](CHANGELOG.md) — what changed in each version. +- [CHANGELOG](CHANGELOG.md) — what changed in each version: the index, with one file per release in [`changelog/`](changelog/). - [CONTRIBUTING](CONTRIBUTING.md) — maintenance mode, what is accepted, and how to add, correct or remove a game. - [PC spec](docs/pc_spec.md) ([VI](docs/i18n/vi/pc_spec.md)) — maintainer's dev hardware + test devices. - [Dev environment](docs/dev_env.md) ([VI](docs/i18n/vi/dev_env.md)) — IDE, toolchains (Python 3.15 / Node 26 / TypeScript 7 / Rust stable / Tauri 2), workflow. diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index 774e6057..cdee9d7c 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -121,7 +121,7 @@ says. A configuration that does both jobs: - Exclude: `web/src-tauri/*`, `web/README.md` Everything not included - `data/**`, `scripts/**`, the other docs, -`CHANGELOG.md`, `CLAUDE.md`, `README.md` - then never deploys. Check it once +`CHANGELOG.md` and `changelog/`, `CLAUDE.md`, `README.md` - then never deploys. Check it once by merging a commit that touches only `docs/plan/` (no build) and one that touches only `docs/ToS.md` (a build), and by the next bot data commit: its check runs on GitHub must have no `Workers Builds: free-steam-games-list`.