note-workflow
Skill0 starsChanged 3 months agoMITView on GitHub
Use when changing code or docs in this repository to route the change through the Agent Notes loop — writing, updating, archiving, or consolidating notes, then verifying and wiring CI evidence.
In this repository6 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .agents/notes/AGENTS.mdAGENTS.md
- .agents/notes/archived/AGENTS.mdAGENTS.md
- .agents/notes/implemented/AGENTS.mdAGENTS.md
- archive-notesSkill
- prose-standardSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Follow this workflow for every non-trivial change so the decision record, verification, and CI evidence land in the same change set.
- Distinctive: line 16
Search the active tree for older notes covering the same decision or mechanism.
- Very specific: line 20
Follow the in-file format from .agents/notes/README.md: the header block, ## Problem, the lifecycle skeleton, and ## Alternatives …
- Very specific: line 24
Run an verify in the project root and fix every violation before moving on.
≈ “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.
Files
Agent Note Workflow
Follow this workflow for every non-trivial change so the decision record, verification, and CI evidence land in the same change set.
1. Classify the change
A change is non-trivial when it alters behavior, architecture, a contract shared across files or packages, process or tooling, testing strategy, an on-disk, wire, or configuration format, or another decision a maintainer may reasonably revisit. A proposal for substantial future work starts in proposed/; a decision already made starts in implemented/. Pick one of the six classes (feature, bug-fix, simplification, architecture, process, testing).
2. Check supersession first
Search the active tree for older notes covering the same decision or mechanism. Update the owning note when one exists; do not create a duplicate. A new note that fully supersedes an implemented note triggers the archive workflow; a partial supersession keeps both notes cross-linked.
3. Write the note
Follow the in-file format from .agents/notes/README.md: the header block, ## Problem, the lifecycle skeleton, and ## Alternatives considered. Implemented notes state shipped reality in the present tense; keep paths, names, and defaults current with the change.
4. Verify
Run an verify in the project root and fix every violation before moving on. Read-only failures name the file, line, and rule.
5. Wire evidence
For a first-time project, run an init then an ci-setup so the same gates run in CI. For an existing project, confirm the CI workflow references npm exec an verify.
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
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.