mirror of
https://github.com/libretro/parallel-gx2.git
synced 2026-11-07 04:25:58 -10:00
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]
This commit is contained in:
1 parent
53142c7c69
commit
0ae3eeda4a
1 file changed
+7
@@ -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 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.
|
- 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.
|
- 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
|
## 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.
|
- 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
|
## 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.
|
- Keep comments true. When a change makes a comment describe behaviour that no longer exists, fix or remove the comment in the same commit.
|
||||||
|
|||||||
Reference in new issue
Block a user