usethis-python

General guidelines for writing tests in the usethis project, including test class organization

Guidelines for Python code design decisions such as when to share vs. duplicate code

Create a lesson from a development difficulty, covering root cause analysis, principle generalisation, and filing as a GitHub issue

Write bespoke prek hooks as reusable Python scripts for custom checks

Check whether docs/config-files.txt (the machine-readable export) is in-sync with the per-tool tables in docs/about/config-files.md

Enforce version bumping, scope checking, and content quality guidelines when modifying SKILL.md files

Modify Python code (e.g. refactor, add new code, or delete code)

Style and testing conventions for working with Python enums

Guidelines for editing documentation — including scope matching, section placement, and content organisation

Review documentation for outdated or inaccurate content by cross-referencing the current source code and project capabilities

Guidelines for Python function design, including return types and signature simplicity

Coordinate LLM-assisted quality reviews of the codebase beyond what automated tools catch

Add a prek hook for dev

Identify tests that are potentially affected by code changes, to catch regressions before CI

Modify the usethis CLI layer (commands, options, help text) and keep documentation in sync

Audit CLI documentation for completeness and sync with source code — checks that every command option visible in the code appears in the reference documentation

Create GitHub issues via the gh CLI to record lessons, track follow-up work, or file bugs discovered during development

Update GitHub Actions workflows

Modify the Python module layout (create, move, rename, or delete modules)

Review code and documentation for grammar, spelling, and tone issues

Perform static code checks

Create new agent skills (SKILL.md files) following best practices for content quality, structure, and discoverability

Maintain AGENTS.md and agent skill configuration

Guidance on where to place new files in the repository

Simulate user testing for CLI commands by running them in a fresh temporary project to verify the happy path

Dogfood new or modified CLI commands by running them against the usethis repo itself to catch edge cases

Write tests that achieve full code coverage and verify coverage locally before pushing

Add an external (community) skill to the project from a third-party source, including installing it and documenting it in AGENTS.md

Reinstall already-tracked external skills from skills-lock.json (e.g. after a fresh clone)

Guidelines for complying with Ruff linter rules instead of suppressing them

Guidance on pre-commit hooks — this project uses prek, not pre-commit directly

Remove files from the project

Use the Import Linter software on the usethis project