agentleFS
tiagosilva07tiagosilva07/zyrax-guard/.claude/skills/production-readiness/SKILL.md

production-readiness

Skill2 starsChanged 3 months agoMITView on GitHub

A go/no-go checklist for shipping code to production. Use this whenever you're about to deploy, finishing a feature, opening a PR for real traffic, or someone asks "is this production-ready". Covers correctness, errors, security, observability, and scale. Applies to Go, React/TypeScript, and C#/.NET.

18 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use observability, testing and 2 more.

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.
  • OpenAISkill

    observability

    Vercel Observability expert guidance — Drains (logs, traces, speed insights, web analytics), Web Analytics, Speed Insights, runtime logs, custom events, OpenTelemetry integration, and monitoring dashboards. Use when instrumenting, debugging, or optimizing application performance and user experience on Vercel.

    Also in 3 projects that use this

  • NVIDIASkill

    testing

    Run Python and Rust tests for physicsnemo-curator using uv + pytest with coverage reporting via pytest-cov, and cargo-nextest for Rust tests. Includes benchmark workflows with pytest-benchmark and criterion.

    Also in 4 projects that use this

  • OpenAISkill

    systematic-debugging

    Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes

    Also in 4 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 18 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run this before code reaches real users.

    line 12
  2. Very specific:

    C#/.NET: no sync-over-async; IDisposable honored.

    line 55

“Common” is measured: kept by at least 6 in 10 of the 18 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

Production-readiness gate

Run this before code reaches real users. Anything unchecked is a conscious risk someone has to accept — not an oversight.

Correctness

  • Tests cover the new logic, including the failure paths — and they pass.
  • Build is clean (no warnings treated as acceptable noise).
  • Edge cases handled: empty, null/nil, very large, concurrent, boundary values.
  • No debug code, dead code, or commented-out blocks left behind.

Error handling

  • Errors are handled or propagated with context — never silently swallowed.
  • User-facing failures are graceful and recoverable; no raw stack traces shown.
  • External calls (DB, network, third party) have timeouts and a failure path.
  • Retries are bounded and idempotent where used.

Security

  • No secrets in code, logs, or client bundles.
  • All external input validated; queries parameterized.
  • AuthN/AuthZ checks on every protected path.
  • (If sensitive surface) ran the security-auditor.

Observability

  • Structured logs at the right level — enough to debug an incident, not so much they leak data or drown signal.
  • Key metrics emitted (latency, error rate, throughput on hot paths).
  • Health/readiness endpoints exist (services).

Performance & scale

  • No obvious N+1 queries or unbounded loops on hot paths.
  • Pagination/limits on anything that can grow unbounded.
  • (If hot path under load) baseline measured; see the perf-optimizer.

Operability

  • Config via env/secret manager, not hardcoded.
  • Graceful shutdown handled.
  • Rollback path exists and is known.
  • DB migrations are backward-compatible (can roll back without data loss).

Stack quick-hits

  • Go: go vet + -race clean on concurrent code; contexts plumbed through; errors wrapped.
  • React/TS: loading/empty/error states present; no any without justification; bundle size sane.
  • C#/.NET: no sync-over-async; IDisposable honored; nullable warnings addressed.

How to use

State which items pass, which fail, and which don't apply. For each failing item, either fix it or get an explicit decision to accept the risk. Don't quietly skip.

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.