agentleFS
nasanasa/fprime/.github/skills/fprime-checklist-design/SKILL.md

fprime-checklist-design

Skill12k starsChanged 21 months agoApache-2.0View on GitHub

Design-stage pass of the F Prime Component Development Checklist. Run after the SDD and FPP model are approved and before implementation: creates the checklist with fprime-auto-checklist, decides the Requirements (section 1) and Design (section 2) review rows from the SDD and model, records each decision with `decide`, and leaves the tool-decided rows alone. Keywords: F Prime, checklist, design stage, requirements review, SDD, FPP, fprime-auto-checklist.

  • Installs packages

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 1 mentionApr 2026: 0 mentionsMay 2026: 22 mentionsJun 2026: 3 mentionsJul 2026: 7 mentionsAug 2026: 2 mentionsSep 2026: 7 mentionsOct 2026: 11 mentionsNov 2026: 1 mention
Dec 2025Jun 2026Nov 2026
Mentions a month of the nasa/fprime repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about nasa/fprime

The biggest 5 of 71 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 71

Talked about on GitHub, YouTube, Hacker News and the web (71 times).

On GitHub · 50

45 more on GitHub

On YouTube · 13

8 more on YouTube

On the web · 2

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run the tool from the project root (it builds the module once for the clang-tidy analysis.

    line 38
  2. Very specific:

    YES: no note. The tool's own rule pointer (R8 pass, ` cpp/fprime/no-printf 0 findings ) is the only text a YES row carries.

    line 89
  3. Very specific:

    Every NO/N/A note names the requirement id(s) or SDD section it rests on.

    line 104
  4. Very specific:

    Never run fprime-util check, coverage, topology builds or hardware steps to make a row pass.

    line 105

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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

Checklist — design stage

Produces docs/checklist.md (+ docs/checklist.json) for a component whose SDD and FPP model have just been approved. The tool decides everything it can; this skill decides the rows the tool queues for the design stage and nothing else. It performs no development step: it does not build unit tests, run coverage, or touch the component.

Procedure

  1. Install the tool from a clone (the clang-tidy plugin is built from the clone, it is not in the pip package); without the plugin every static-analysis row (31 of them) comes back UNCHECKED, so do not skip it:

    git clone https://github.com/LeStarch/fprime-auto-checklist && cd fprime-auto-checklist
    pip install -e .
    sudo apt-get install -y clang-tidy-15 llvm-15-dev libclang-15-dev   # LLVM 15 (plugin and clang-tidy must match)
    cmake -S native -B native/build -DClang_DIR=/usr/lib/llvm-15/lib/cmake/clang && cmake --build native/build
    cd -   # back to the project root; run the tool from there

    A prebuilt plugin is picked up from $FPRIME_TIDY_PLUGIN (--tidy-plugin), clang-tidy from $CLANG_TIDY (--clang-tidy).

  2. Run the tool from the project root (it builds the module once for the clang-tidy analysis; that is the only build it performs):

    fprime-auto-checklist run --module <Path/To/Component> --analyzer clang-tidy \
        --stage design -o <Path/To/Component>/docs/checklist.md

    The Hand-off section and checklist.json → queue list the rows to decide, each with its review rule (rule_text). At this stage the queue is the section-1 rows 1.1–1.6 (rule CL-6) plus any section-2 rows the tool left at REVIEW. Rows of sections 3–5 are marked deferred; leave them.

  3. For each queued row, read the SDD requirements table and the FPP model and apply the rule verbatim. For CL-6 (1.1–1.6): list every requirement, decide whether the aspect the item names (behaviour, input data, output data, memory, hardware I/O, runtime performance) is constrained by at least one of them, or is declared not applicable with a rationale in the SDD. Do not infer a convention (no Kind column, no keyword table) — judge the text.
  4. Record every decision through the tool, never by editing the Markdown:

    fprime-auto-checklist decide --checklist <...>/docs/checklist.md \
        --item 1.4 --status YES --note "REQ-003/REQ-007 bound all buffers; no heap after init (SDD §3.4)."

    --status is YES, NO or N/A; NO and N/A take a one-line --note (see Notes discipline). --from decisions.json records a batch ([{"id","status","notes"}]). The tool stamps each decision with the commit and the section-1/2 fingerprint so later stages know when the SDD or model changed under it.

  5. Link the checklist from the SDD: its very last line is Component Development Checklist: [checklist.md](checklist.md) — append it once, after Tests, nothing after it:

    grep -qxF 'Component Development Checklist: [checklist.md](checklist.md)' <Path/To/Component>/docs/sdd.md || \
        printf '\nComponent Development Checklist: [checklist.md](checklist.md)\n' >> <Path/To/Component>/docs/sdd.md
  6. Re-run step 1 with --previous <...>/docs/checklist.md and confirm the Hand-off section says Nothing to review at the design stage. Report the totals line and every row that is NO, with its note, to the user; tool NOs (e.g. a missing SDD table) are fixed in the SDD/model, not in the checklist.

Notes discipline

The rendered table is read by people; keep it sparse.

  • YES: no note. The tool's own rule pointer (R8 pass, `cpp/fprime/no-printf` 0 findings) is the only text a YES row carries; your --note (one clause, the ids you checked) is stored in the JSON for traceability and is not rendered.
  • NO: one line, what is wrong and where — file:line, requirement id or table — and the fix in a few words. No requirement-by-requirement walks, no restating the tool's finding, no "Confirmed:" prefixes.
  • N/A: one clause stating why the item does not apply.
  • UNCHECKED: name the process step that has not been performed.
  • Audits that confirm the tool's verdict are silent in the table; an override renders as one Audit (...) line from your --note.

Rules

  • Decide only the rows in the queue. A tool-decided row is audited at close-out, not here.
  • Every NO/N/A note names the requirement id(s) or SDD section it rests on.
  • Never run fprime-util check, coverage, topology builds or hardware steps to make a row pass; rows that need them stay UNCHECKED "not done yet" until the process performs them.

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.