You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,18 +16,18 @@ FnQuake3 is a modernized Quake III Arena engine branch. Every change should prot
16
16
- Keep release packaging deterministic. `.install/` is the staged distribution area, not a scratchpad.
17
17
- Use `.tmp/` for temporary outputs, investigation notes, and disposable staging work.
18
18
- Do not ship documentation that mixes end-user guidance with maintainer detail. Keep the user surface in `README.md` and deeper material in linked technical docs.
19
-
- When versioning changes are required, update the canonical metadata in [`version/fnq3_version.h`](/e:/Repositories/FnQuake3/version/fnq3_version.h) first.
19
+
- When versioning changes are required, update the canonical metadata in `version/fnq3_version.h` first.
-[`docs/TECHNICAL.md`](/e:/Repositories/FnQuake3/docs/TECHNICAL.md): maintainer-facing project, release, and repo notes.
26
-
-[`version/fnq3_version.h`](/e:/Repositories/FnQuake3/version/fnq3_version.h): single source of truth for project version metadata.
27
-
-[`scripts/version.py`](/e:/Repositories/FnQuake3/scripts/version.py): version/channel helper for humans and CI.
28
-
-[`scripts/generate_docs.py`](/e:/Repositories/FnQuake3/scripts/generate_docs.py): refreshes `README.md` and `.install/README.html` from templates.
29
-
-[`scripts/release.py`](/e:/Repositories/FnQuake3/scripts/release.py): stages artifacts through `.install/` and produces release archives plus manifests.
30
-
-[`.github/workflows/build.yml`](/e:/Repositories/FnQuake3/.github/workflows/build.yml): CI build, nightly packaging, and tagged release flow.
-`docs/fnquake3/TECHNICAL.md`: maintainer-facing project, release, and repo notes.
26
+
-`version/fnq3_version.h`: single source of truth for project version metadata.
27
+
-`scripts/version.py`: version/channel helper for humans and CI.
28
+
-`scripts/generate_docs.py`: refreshes `README.md` and `.install/README.html` from templates.
29
+
-`scripts/release.py`: stages artifacts through `.install/` and produces release archives plus manifests.
30
+
-`.github/workflows/nightly.yml`: nightly packaging and release flow.
31
31
32
32
## Directory Map
33
33
@@ -40,7 +40,7 @@ FnQuake3 is a modernized Quake III Arena engine branch. Every change should prot
40
40
41
41
## Release Workflow
42
42
43
-
1. Update [`version/fnq3_version.h`](/e:/Repositories/FnQuake3/version/fnq3_version.h) for the next tagged release.
43
+
1. Update `version/fnq3_version.h` for the next tagged release.
44
44
2. Run `python scripts/generate_docs.py` to refresh user-facing docs.
45
45
3. Build platform artifacts.
46
46
4. Run `python scripts/release.py --channel nightly` or `python scripts/release.py --channel release --ref-name <tag>` against the downloaded artifact directory.
@@ -50,4 +50,4 @@ FnQuake3 is a modernized Quake III Arena engine branch. Every change should prot
50
50
51
51
- If a change touches runtime identity strings, keep compatibility-sensitive behavior unchanged unless the user explicitly wants a compatibility break.
52
52
- If you have to choose between a cleaner abstraction and a safer compatibility-preserving patch, default to the compatibility-preserving patch and document the tradeoff.
53
-
- When release packaging changes, ensure `.install/README.html` remains valid and the package still includes `README.md`, `BUILD.md`, `LICENSE`, and `docs/TECHNICAL.md`.
53
+
- When release packaging changes, ensure `.install/README.html` remains valid and the package still includes `LICENSE` and `docs/fnquake3/TECHNICAL.md`.
0 commit comments