From 0ae3eeda4a56811bd607bdd1b3383e997067b260 Mon Sep 17 00:00:00 2001 From: WizzardSK <42868978+WizzardSK@users.noreply.github.com> Date: Sun, 11 Oct 2026 19:47:15 +0200 Subject: [PATCH] AGENTS.md: the changelog and the README are kept up with each change, and CHANGELOG.md stays this fork's on a merge [skip ci] --- AGENTS.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index b3ddc9fb..c63128a0 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -20,11 +20,18 @@ This repository builds the libretro core and nothing else. The standalone's part - When upstream changes a CMake file around one of the removed options or backends, keep them removed and take the rest of the change. - When something new is deleted for the same reason, add its path to `.upstream-excluded` in the same commit. - After a merge, the core's version (`library_version` in `src/libretro/CemuLibretro.cpp` and `cemu_libretro.info`) is `git describe` of the upstream commit merged, and a new release is built. +- `CHANGELOG.md` is this fork's own. When a merge conflicts on it, keep this one. ## These files - Only the developer writes to or deletes `AGENTS.md` and `CLAUDE.md`. An agent does not change them on its own; it proposes the change to the developer instead. +## Changelog and README + +- `CHANGELOG.md` is updated in the same commit as the change it describes: what changed for someone using the core, newest first. Not a copy of the commit message. +- A change on a feature branch gets its entry on that branch, under "Unreleased"; it reaches `libretro` with the squash merge. +- `README.md` is kept true in the same way: when a change makes a sentence in it wrong (a limit lifted, an option added, a file moved), fix the sentence in that commit. + ## Code - Keep comments true. When a change makes a comment describe behaviour that no longer exists, fix or remove the comment in the same commit.