agentleFS
theinternetitheinterneti/TTA.dev/.github/skills/self-review-checklist/SKILL.md

self-review-checklist

Skill0 starsChanged 7 months agoMITView on GitHub

Use this skill before submitting code for review or merging a pull request. Covers a pre-merge checklist of common mistakes to catch across code quality, testing, security, and documentation. Invoke when the user says "review my code", "pre-merge check", "self-review", "am I ready to submit", or before opening a PR.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run through this checklist before marking any task or PR as complete.

    line 8

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Self-Review Checklist (TTA.dev)

Run through this checklist before marking any task or PR as complete.

Code Quality

  • All new functions have type annotations (str | None, not Optional[str])
  • All public functions have Google-style docstrings
  • No manual retry/timeout/cache loops — use primitives
  • State passed via WorkflowContext, not globals
  • Import order: stdlib → third-party → local

Testing

  • 100% coverage on new code
  • Tests follow AAA pattern (Arrange-Act-Assert)
  • Uses MockPrimitive for mocking (not real implementations)
  • Uses @pytest.mark.asyncio on async tests
  • Tests cover success, failure, and edge cases
  • No external dependencies in tests (databases, APIs, filesystem)

Security

  • No secrets or credentials in code
  • No new eval(), exec(), or subprocess.shell=True
  • URL validation uses urlparse(), not substring checks

Quality Gate

  • uv run ruff format --check . — zero violations
  • uv run ruff check . — zero violations
  • uvx pyright ttadev/ — zero errors
  • uv run pytest -v — all tests pass

Documentation

  • README updated if public API changed
  • Code examples are copy-paste runnable
  • Changed files have updated docstrings

Deep Reference

  • Testing details: docs/agent-guides/testing-architecture.md
  • Python standards: docs/agent-guides/python-standards.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.