- skill/python-tdd/SKILL.md ported from ~/.agents (MD029 numbering fixed) - autotest.py: sanity, python_syntax, pycodestyle, shellcheck, frontmatter, markdown checks on every script and md file - all green Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
2.0 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
-
Create a directory named after the skill:
skill/<kebab-case-name>/. -
Add
skill/<name>/SKILL.mdwith 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 --- -
Write the instructions below the front matter. Cover identity, rules, workflow, and examples; avoid references that only make sense inside your machine.
-
Add the skill to the table in README.md.
-
Run the checks. All of them must pass:
python -m pip install -r requirements.txt python autotest.py -
Commit with a semantic message, e.g.
feat: add skill <name>. If you plan to publish, keep the pip package name in sync with the repo.
Changing a skill
- Bump the
versionin the front matter for every change: patch for fixes, minor for additions, major for breaking changes. - Keep
SKILL.mdthe 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 limitpython_syntax—.pyfiles parsepycodestyle— PEP 8 on.pyfilesshellcheck— shell scripts lint cleanfrontmatter— YAML header valid,nameandversioncorrectmarkdown— markdownlint (md013line length andmd033inline HTML are ignored)
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.