Imported from yquake2/yquake2remaster (
.agents/AGENTS.md). Install upstream withnpx skills add yquake2/yquake2remaster --skill .agents. Copyright stays with the author.
Agent Instructions for Yamagi Quake II Remaster
These instructions are intended to guide AI agents when generating or modifying
code in this repository. They are derived from the human contributor guidance
found in doc/080_contributing.md.
If you use any AI tool during development, please include a Co-authored-by
line in your commit message, just as you would when crediting human collaborators.
All code must be reviewed and validated by you, and you bear full responsibility
for its correctness and quality.
Example:
Co-authored-by: Copilot <https://copilot.microsoft.com>
or
Co-authored-by: Gemini <gemini@google.com>
Principles & Scope
- Ask before writing code: As a golden rule, always check whether an idea or feature is in scope for Yamagi Quake II before implementation. An early "no" saves wasted effort.
- Scope: Only propose changes that fit the Yamagi Quake II project scope. If uncertain, ask instead of guessing.
- No new dependencies: Do not introduce new third-party libraries or build dependencies. If a helper is required, prefer existing code or ask for permission first.
- Small, focused commits: Prefer a sequence of small, self-contained commits rather than a single large patch.
Code Quality & Style
For detailed coding rules, const/static correctness, compiler requirements, and best practices, see .agents/docs/code_style.md.
Documentation & Workflow
- Update docs: If you add or change functionality, update the relevant document in
doc/(installation, configuration, commands, cvars, packaging, etc.) unless the change is trivial. - Contribution path: Deliver contributions via GitHub forks and pull requests.
- Commit messages: Suggest clear, concise commit messages that reflect small, logical steps, focusing on why changes were made.