agentleFS
DangoSysDangoSys/skills/programming-principles/SKILL.md

programming-principles

Skill1 starsChanged 2 months agoApache-2.0View on GitHub

Apply the repository's programming rules during implementation or code review. Use when a user asks for coding principles, requests a code change, or asks whether a design is unnecessarily complex.

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    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:

    Keep It Simple (KISS): Prefer direct, readable code.

    line 10
  2. Distinctive:

    No fallback: Do not silently recover from an unexpected state, invent a default, truncate data, or continue with partial results.

    line 11
  3. Distinctive:

    Break compatibility decisively: Do not preserve obsolete APIs, aliases, migration shims, dual formats, or old behavior unless compatibility …

    line 13

≈ “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

Programming Principles

Apply these rules:

  1. Keep It Simple (KISS). Prefer direct, readable code. Do not introduce a pile of helpers, wrappers, abstractions, or indirection for a one-off operation.
  2. No fallback. Do not silently recover from an unexpected state, invent a default, truncate data, or continue with partial results. Raise an error immediately when behavior is outside the contract.
  3. No unnecessary defensive programming. Do not add checks for conditions that the type system, caller contract, or an operation already guarantees. If the operation naturally fails and exits, let it fail. Add a check only when it changes the error contract or prevents destructive side effects.
  4. Break compatibility decisively. Do not preserve obsolete APIs, aliases, migration shims, dual formats, or old behavior unless compatibility is explicitly part of the task. Make the clean architectural change and update its callers.
  5. Do not write documentation. Do not create new docs, guides, changelogs, migration notes, or explanatory compatibility text. After a code change, update an existing document only when the changed behavior requires it, and preserve that document's existing format. Do not add notices such as “removed” or “previously supported” to preserve old context.

These rules govern implementation choices, not the user's explicit requirements. When a requirement conflicts with a rule, follow the user's requirement and call out the trade-off briefly.

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.