Imported from nachem/runTiyul (
AGENTS.md). Install upstream withnpx skills add nachem/runTiyul. Copyright stays with the author.
Instructions for Coding Agents
These instructions apply to every AI coding assistant and automated agent working anywhere in this repository.
GitHub Copilot-specific repository instructions are also available at its
standard location,
.github/copilot-instructions.md.
Mandatory wiki workflow
Before making changes:
- Read
docs/wiki/INDEX.md. - Follow its reading order and source-of-truth rules.
- Inspect the source code and tests relevant to the task.
Before declaring any task complete:
- Update the relevant files under
docs/wiki/when requirements, implementation, architecture, setup, validation, or known limitations changed. - Update
docs/wiki/INDEX.mdwhenever:- A wiki page is added, removed, renamed, or changes purpose.
- A feature changes implementation status.
- The current milestone, next priority, or an open decision changes.
- Validation evidence or the wiki's last-reviewed date changes.
- Keep the index concise. Put detailed content in the appropriate wiki page and link to it from the index.
- Verify every local Markdown link after documentation changes.
- Never mark a feature implemented based only on plans, dependencies, generated files, or untested code.
Code and automated tests are the source of truth for implemented behavior. The wiki must accurately summarize that behavior for future agents.
Documentation standards
- Use absolute dates in
YYYY-MM-DDformat. - Separate required, implemented, partially implemented, and unimplemented behavior.
- Record commands actually run and their results; do not infer validation.
- Document unresolved limitations and production-readiness concerns.
- Do not commit secrets, provider credentials, or personal location data.
- Do not create planning documents outside the established wiki unless the user explicitly requests one. Extend the existing pages instead.
Completion checklist
- Requested behavior is implemented completely.
- Relevant tests and analysis pass.
- Real-device limitations are stated where device validation was required.
- Relevant wiki pages are synchronized with the code.
-
docs/wiki/INDEX.mdis synchronized with the wiki and project status. - Local Markdown links resolve.