Get the FREE Ultimate OpenClaw Setup Guide →

audit

npx machina-cli add skill bryanp/agent-skills/audit --openclaw
Files (1)
SKILL.md
490 B

Look through the codebase and compare the code against the rules, philosophy, and style described in AGENTS.md and other documentation. Employ the oracle as needed for this work. Ignore the implementation itself (as well as implementation plans). This is purely an exercise in fixing style/philosophy problems.

Rule: Commit Work

Use the git-commit skill to commit your work after the audit is complete.

Source

git clone https://github.com/bryanp/agent-skills/blob/main/code/audit/SKILL.mdView on GitHub

Overview

This skill audits the codebase for consistency with the rules, philosophy, and style described in AGENTS.md and related docs. It ignores implementation details and focuses on identifying style and philosophy violations. The oracle can be used to resolve ambiguities, and the audit culminates in a commit of the fixes.

How This Skill Works

Iterate over files to compare code against AGENTS.md and documentation, flagging deviations in formatting, naming, structure, and philosophy. Use the oracle to resolve unclear rules and log recommended fixes; do not modify underlying behavior or implementation plans. After completing the audit, prepare a commit containing the changes with a clear message.

When to Use It

  • When onboarding a project to align with AGENTS.md style
  • When you detect inconsistent formatting, naming, or structure across files
  • Before merging a PR to enforce code style and philosophy
  • During periodic maintenance to address style drift
  • When documenting or auditing to verify alignment with documentation

Quick Start

  1. Step 1: Scan the repository for deviations against AGENTS.md (use the oracle as needed).
  2. Step 2: Collect deviations with concrete fixes and rationale.
  3. Step 3: Commit the audit results using the git-commit skill with a clear message.

Best Practices

  • Always reference AGENTS.md and related docs during audits
  • Ignore implementation and behavior; focus on style and philosophy
  • Use the oracle to resolve rules that are ambiguous or context-dependent
  • Document deviations with concrete examples and suggested fixes
  • Commit audit results with a concise, actionable message via git-commit

Example Use Cases

  • Fix inconsistent indentation and trailing whitespace across modules
  • Harmonize naming conventions (e.g., snake_case vs camelCase) within a project
  • Remove dead or commented-out code that violates the philosophy
  • Standardize module layout to match AGENTS.md structure
  • Annotate formatting issues with inline notes and proposed changes

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers