agentleFS
tamdogoodtamdogood/parler-protocol/.claude/skills/code-standards/SKILL.md

code-standards

Skill15 starsChanged 4 months agoApache-2.0View on GitHub

Apply Parler Protocol's engineering contract to a code change. Use whenever implementing a feature, fixing a bug, or refactoring in this repo — before writing code, not after. Walks orient → baseline → smallest change → test → verify → self-review, and enforces the hard gates (never cargo fmt, clippy -D warnings, make ci green, additive wire changes only, security invariants).

17 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 0 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 14 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Orient: Read tasks/lessons.md (hard-won traps.

    line 21
  2. Very specific:

    Verify: run make ci until green before "done".

    line 31
  3. Very specific:

    add a dependency → transitive check, one non---locked build, strict cargo-deny licenses

    line 40
  4. Very specific:

    write a secret to disk → parler_auth::write_private_file, never write-then-chmod

    line 42

“Common” is measured: kept by at least 6 in 10 of the 14 edited versions of this file we could read. “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

Code standards — the change workflow

You are making a code change in the Parler Protocol repo. The full contract is docs/engineering-guidelines.md — read it once per session (it's short). This skill is the execution order.

Steps

  1. Orient. Read tasks/lessons.md (hard-won traps; obey them). Find the subsystem's doc in AGENTS.md's index and read only that one.
  2. Plan if non-trivial (3+ steps or an architectural choice): short plan in tasks/todo.md — files touched, tests to add, risks. Going sideways → stop and re-plan.
  3. Baseline: scripts/verify.sh --rust-only green before touching anything. A pre-existing red is the first task.
  4. Implement the smallest root-cause change. Hand-match the surrounding style. Never cargo fmt.
  5. Test: new behavior gets a test that fails without the change; security gates get negative-assertion tests (wrong token → 401, cursor unchanged, no leak).
  6. Verify: run make ci until green before "done".
  7. Self-review your own diff against docs/code-review-guidelines.md (or invoke parler-review). Fix findings before presenting.
  8. Close out: docs updated in the same change; append to tasks/lessons.md if you were corrected or surprised; conventional commit message (feat|fix|docs(scope): …).

Tripwires — stop and check the guidelines when you're about to…

  • change anything in crates/parler-protocol/ → ripple rules + additive-only wire contract
  • add a dependency → transitive check, one non---locked build, strict cargo-deny licenses
  • touch membership, tokens, or any auth path → audit every writer/reader path, negative tests
  • write a secret to disk → parler_auth::write_private_file, never write-then-chmod
  • hold a lock near an .await, or read env inside logic → extract a pure decision fn

No-progress guard

The same failure surviving two fix attempts means stop: append the finding to tasks/lessons.md, mark the item [BLOCKED], and surface it. Don't thrash.

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.