agentleFS
sreejithramansreejithraman/SreeStack/skills/engineering-principles/SKILL.md

engineering-principles

Skill1 starsChanged 16 days agoMITView on GitHub

Guide engineering design and implementation decisions. Use when choosing data models or interfaces, simplifying code, planning migrations, handling retries or shared state, evaluating evidence, or organizing substantial work.

22 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use component-release and release.

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.
  • Microsoft AzureSkill

    component-release

    Prepares a verifiable Agent Landing Zone UI release. Use for release branches, VERSION, changelog entries, tags, release notes, and compatibility evidence; never publish without explicit human approval.

    Also in 4 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 9 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 21 edited versions we read keep these.

  • 3

    Distinctive

    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:

    Use these principles to choose the shape of the work.

    line 8
  2. Distinctive:

    Read only the principles that match the decision before acting.

    line 12
  3. Distinctive:

    Keep proposed checks distinct from checks run.

    line 59

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

Engineering Principles

Use these principles to choose the shape of the work. The relevant workflow still owns its procedure, checks, and completion criteria. Apply them within the user's scope, product requirements, and execution permissions.

Read only the principles that match the decision before acting. Each link opens one principle; a named request selects that principle directly.

Data, types, interfaces, or product tradeoffs

  • Foundational Thinking: when choosing data structures, access patterns, invariants, or state ownership before writing logic.
  • Redesign From First Principles: when a new requirement calls an existing design into question.
  • Model the Domain: when lifecycle transitions, interacting flags, async completion, or repeated domain rules make behavior hard to reason about.
  • Boundary Discipline: when parsing external input, enforcing trust boundaries, or introducing framework adapters.
  • Type System Discipline: when designing types, signatures, or schemas that should rule out invalid operations.
  • Experience First: when product, interface, or feature-scope tradeoffs compete with implementation convenience.

Refactoring or code that is hard to follow

  • Laziness Protocol: when refactoring or considering another abstraction, dependency, or layer.
  • Subtract Before You Add: when sequencing an addition, refactor, or rewrite around existing dead or redundant structure.
  • Minimize Reader Load: when layers, hidden state, or pass-through wrappers make code hard to follow.

Retries, concurrent writers, or caller migration

  • Outcome-Oriented Execution: when planning a rewrite or migration with explicit development and delivery boundaries.
  • Make Operations Idempotent: when commands, lifecycle steps, or processing loops can repeat, crash, or restart.
  • Migrate Callers Then Delete Legacy APIs: when introducing a replacement internal interface while callers still use the old route.
  • Separate Before Serializing Shared State: when concurrent actors might write the same file, key, object, or shared state.

Failed fixes, competing designs, tests, or measured claims

  • Attack the Premise: when successive fixes share an assumption and keep failing the same check.
  • Exhaust the Design Space: when a novel interaction or unresolved architecture tradeoff needs a concrete comparison.
  • Prove It Works: when deciding whether an artifact or consumer workflow satisfies the requested outcome.
  • Fix Root Causes: when diagnosing a defect or repairing a symptom that may affect sibling callers.
  • Test Behavior, Not Implementation: when choosing assertions, expected results, or mocks that must detect broken behavior.
  • Explain the Number: before trusting, reporting, or acting on a performance measurement or evaluation result.

Sweeps, delegation, long tasks, or repeated instructions

  • Build the Lever: when substantial or repeated work could benefit from a rerunnable tool or shared recipe.
  • Sequence work into verifiable units: when ordering dependent edits, migration stages, commits, or PR layers into checkable increments.
  • Guard the Context Window: when large outputs, repeated reads, or broad investigations crowd out useful context.
  • Never Block on the Human: when routine, reversible uncertainty tempts a question that repository evidence or an experiment can settle.
  • Encode Lessons in Structure: when repeated instructions or recurring corrections reveal a rule that needs durable enforcement.

For a cross-cutting task, read the applicable principles across groups. Give delegates the relevant file paths and the decision or proof they own through Orchestration.

Explain the concrete choice and its evidence when it matters to the result. Keep proposed checks distinct from checks run. A principle name or a completed checklist does not establish that the behavior works.

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.