Skip to content

Latest commit

 

History

History
54 lines (46 loc) · 4.42 KB

File metadata and controls

54 lines (46 loc) · 4.42 KB

Agents and AI guidance

All agent definitions, skills, and project rules live under .claude/. Use that tree whether you use Claude Code, Cursor, GitHub Copilot, or another assistant: open or reference the files directly, and use each product's own mechanics for attaching repo context where needed.

  • Hard prerequisite before any repository edit: Read .claude/rules/general.md in full (including Before editing repository files), then every other relevant .claude/rules/*.md for the paths you will change, and any applicable .claude/agents/*.md or .claude/skills/*/SKILL.md (for example when the task follows CI, regen, or another named workflow, or the user names an agent or skill). Do this before creating, modifying, or deleting tracked files.
  • If the user is only adding instructions for the assistant, do not edit the repository unless they ask for a concrete change.

Rules (.claude/rules/)

File Scope
general Project-wide conventions
python Python coding (**/*.py, **/*.pyi)
python-tests Test conventions (tests/**/*.py)
json-yaml JSON and YAML files
toml-ini TOML and INI files
markdown Markdown files
prose Prose in Markdown, comments, docstrings, and strings

Skills (.claude/skills/)

Skills are folders with a SKILL.md file (for example ci or make-release when present). The make-release skill drives the changelog, version bump, and push. The prose-lint skill audits prose against .claude/rules/prose.md and applies the fixes.

Agents (.claude/agents/)

Agent Purpose
click-auditor Validate Click command consistency.
coverage-improver Identify coverage gaps and write tests.
docstring-fixer Audit and fix missing/incomplete docstrings.
mypy-fixer Fix mypy errors and eliminate Any.
python-expert General expert-level Python coding (includes mypy/typing).
python-moderniser Upgrade code to modern Python features.
test-writer Generate tests following project patterns.
markdownlint-fixer Fix markdownlint-cli2 issues.
qa-fixer Run yarn format and yarn qa until clean.
workflow-shellcheck ShellCheck embedded Bash in workflow YAML.
badge-sync Sync docs/badges.rst with README.md.
changelog Update CHANGELOG.md with entries since last release.
copy-editor Fix prose style, grammar, and spelling in comments/strings.
regen Run Wiswa, post-process, verify, and commit.
wiswa-sync Reflect managed file changes back to .wiswa.jsonnet.