agentleFS
HermeticOrmusHermeticOrmus/dx-audit-skills/.cursor/rules/dx-audit.mdc

dx-audit-skills / rules

Cursor rule0 starsChanged 6 months agoMITView on GitHub

DX audit protocol. Inspect README, quickstart, scripts, contributing guide, env docs, error messages, and tooling, score friction, and report or implement fixes.

  • Reads credentials

The file

Files
dx-audit.mdc
---
description: DX audit protocol. Inspect README, quickstart, scripts, contributing guide, env docs, error messages, and tooling, score friction, and report or implement fixes.
alwaysApply: false
---

# DX audit

A protocol for auditing and improving developer experience in a codebase. Walk it as a new contributor would. Situational, so invoke it when onboarding friction surfaces.

## What to inspect

1. README: first-paragraph clarity, a copy-pasteable quickstart, current commands.
2. Quickstart and setup: the clone-to-running path, in dependency order, with prerequisites.
3. Scripts: install / dev / build / test / lint / format in a task runner, with names that match the docs.
4. Contributing guide: branch naming, commit format, PR rules, how to run tests, not drifted from reality.
5. Environment docs: an `.env.example` listing every variable, annotated with what it is and where to get it.
6. Error messages: setup fails loudly and actionably, not with a raw stack trace.
7. Tooling: linter, formatter, type-checker wired to a hook or CI so they run without being remembered.

## How to score friction

Per dimension: None (works, discoverable) / Low (incomplete or stale) / Medium (wrong or absent where it matters) / High (absent or misleading, blocks the contributor). Anchor with two timings: time to first run (clone to running app) and time to first contribution (clone to tested, formatted, ready PR).

## Modes

- Report-only (default): inspect, score, produce a prioritized findings list grouped by effort. Change nothing.
- Implement: apply fixes with approval, highest-friction and lowest-effort first; verify each on a clean checkout.

A README that has not been run on a clean checkout is a guess, not a fix.

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.