|
| 1 | +# Agent Instructions |
| 2 | + |
| 3 | +## Issues |
| 4 | + |
| 5 | +Before creating an issue, review the available issue templates in the `.github` directory. |
| 6 | + |
| 7 | +When drafting the issue: |
| 8 | + |
| 9 | +- Use the most appropriate template. |
| 10 | +- Follow the template structure. |
| 11 | +- Fill in all required sections. |
| 12 | +- Remove sections that the template explicitly marks as optional or not applicable. |
| 13 | +- Do not invent reproduction steps, logs, screenshots, or expected behavior. |
| 14 | + |
| 15 | +## Pull Requests |
| 16 | + |
| 17 | +Before creating a pull request, read `.github/PULL_REQUEST_TEMPLATE.md`. |
| 18 | + |
| 19 | +When drafting the pull request: |
| 20 | + |
| 21 | +- Follow the template structure. |
| 22 | +- Use the title format required by the template. |
| 23 | +- Fill in or remove each section according to the template guidance. |
| 24 | +- Include testing details, or explain why testing was not run. |
| 25 | +- Do not invent testing results. |
| 26 | +- Do not claim validation, verification, or review steps that were not actually performed. |
| 27 | + |
| 28 | +## Git Commits |
| 29 | + |
| 30 | +When creating commits, follow the repository `git-commit` skill rules: |
| 31 | + |
| 32 | +- Use Conventional Commits title format: `type(scope): subject`. |
| 33 | +- Allowed types: `feat`, `fix`, `refactor`, `perf`, `docs`, `style`, `test`, `build`, `ci`, `chore`, `revert`. |
| 34 | +- Use a meaningful scope based on the main module, package, or feature. |
| 35 | +- Write the subject in imperative mood and describe the actual change. |
| 36 | +- Use a concise Markdown list in the commit body, with each item describing one key change. |
| 37 | +- Do not invent changes that are not present in the diff. |
| 38 | +- Do not describe behavior, refactors, fixes, or tests that are not reflected in the commit. |
| 39 | + |
| 40 | +Include at most one `Co-authored-by` trailer that matches the AI assistant actually used to produce the change. |
| 41 | + |
| 42 | +Examples: |
| 43 | + |
| 44 | +- `Co-authored-by: Codex <267193182+codex@users.noreply.github.com>` |
| 45 | +- `Co-authored-by: GitHub Copilot <copilot@github.com>` |
| 46 | +- `Co-authored-by: Claude <81847+claude@users.noreply.github.com>` |
| 47 | + |
| 48 | +If you are not one of the listed assistants, do not add a `Co-authored-by` trailer. |
| 49 | + |
| 50 | +Instead, ask the human collaborator to provide the exact `Co-authored-by` trailer to use. Do not invent, infer, or generate one yourself. |
0 commit comments