Files
phronesis/CONTRIBUTING.md
T
nvaldez 196df53a9b phronesis v0.2.0: the CLI app per SPEC.md - list, filter, install, update
- SPEC.md sectionized with stable ids (sectionize-markdown conventions)
- src/phronesis: cli, registry, harnesses (modular, vibe first), state,
  formatting, completions; argcomplete completion; exit codes per SPEC
- phronesis              -> version line + skill table (name, version, category,
  description wrapped below, daedalus-style)
- phronesis <category>   -> filtered table; close-match typos for skills+categories
- phronesis <skill> --install | --project  [--harness <name>] [-f]
  installs whole skill dir; prompt when present; EOF/default = skip; -f no prompt
- phronesis --update     -> refresh every state entry; warns unbundled; reinstalls missing
- state: <config>/phronesis/installed.json, unique by (name, harness, scope)
- skill/python-tdd bumped 1.2.0 with category: development
- test/ (56 tests, 92% cov) + autotest pytest check with 75% floor;
  all 7 autotest checks green

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
2026-11-19 09:50:45 +01:00

2.2 KiB

Contributing to phronesis

A skill is one directory under skill/ containing a single SKILL.md file. It must be self-contained: anyone (or any agent) reading only that file should be able to follow the skill.

Adding a skill

  1. Create a directory named after the skill: skill/<kebab-case-name>/.

  2. Add skill/<name>/SKILL.md with this front matter:

    ---
    name: <name>            # must equal the directory name
    version: x.y.z          # semantic, start at 1.0.0
    description: <one line> # what the skill is for
    category: <kebab>      # lowercase label, used by `phronesis <category>`
    ---
    
  3. Write the instructions below the front matter. Cover identity, rules, workflow, and examples; avoid references that only make sense inside your machine.

  4. Add the skill to the table in README.md.

  5. Run the checks. All of them must pass:

    python -m pip install -r requirements.txt
    python -m pip install -e .
    python autotest.py
    
  6. Commit with a semantic message, e.g. feat: add skill <name>. A new category is announced to users the moment the skill is bundled, since phronesis lists it live.

Changing a skill

  • Bump the version in the front matter for every change: patch for fixes, minor for additions, major for breaking changes.
  • Keep SKILL.md the only required file; support files are allowed but must stay inside the skill's directory.

Check failures

autotest.py <check> runs one check; without arguments it runs all:

  • sanity — LF line endings, no private keys, file size limit
  • python_syntax — .py files parse
  • pycodestyle — PEP 8 on .py files
  • shellcheck — shell scripts lint clean
  • frontmatter — YAML header valid, name, version, and category correct
  • markdown — markdownlint (md013 line length and md033 inline HTML are ignored)
  • pytest — the suite in test/, coverage floor 75 percent

Style

  • KISS/YAGNI: a skill that fits in one screen beats a manual.
  • Plain, imperative sentences. Lists over prose where order matters.
  • Test what you preach: a TDD skill is itself written cleanly.

License

By contributing you agree your work is released under the MIT license.