Files
phronesis/CONTRIBUTING.md
T
nvaldez 0e4fe45bc1 docs: SPEC.md section 12 Release + layout sync - spec current with the repo
Audit found the spec accurate through the skills port but silent on the
release tooling. Added section 12 (publish.py guards and exit codes,
roller-tag tolerance, immutable published versions, absolute-link README
rule found at 0.1.0, MANIFEST.in and dist/ policy) and refreshed the item
2.1 tree (publish.py, MANIFEST.in, dist/, skill support files).
CONTRIBUTING gains a short Releasing section pointing at SPEC 12.

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

2.7 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.

Releasing

  • Bump version in pyproject.toml, commit, then tag the release: git tag -a v<x.y.z> -m "..." and move the stable/latest roller tags (git tag -f ..., git push -f origin stable latest).
  • python publish.py guards, builds, and twine-checks exactly the tagged version; python publish.py --upload publishes it (SPEC.md section 12). A published version is immutable: any change, even to the README, is a new version.

License

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