Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (56 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

88 lines (56 loc) · 4.46 KB
Raw

Contributing

Keep each change limited to the part of the agent setup you want to improve.

Choose the source

Change Source and contribution route
Rules Propose wording against rules/AGENTS.md. The source owner regenerates this snapshot.
Workflows Edit orchestration or the repository protocol. Keep their responsibilities distinct.
Harness configuration Update the OMP example or Claude Code example. Record what you checked and remove private values.
Skills Follow the ownership and catalog steps below.

rules/AGENTS.md is generated from the maintainer's local rules file. If you maintain that source, follow the rules sync instructions. Other contributors should describe the proposed policy change for the source owner.

For OMP changes, keep the model role examples consistent with the operating workflow. Describe configuration values as examples unless you tested them. Include evidence for claims about supported models or harness behavior.

Add or update a skill

  1. Put collected work in skills/<name>/ or verified original work in my-skills/<name>/.
  2. Include name and description in SKILL.md frontmatter. Add the skill to one catalog group in scripts/build-index.py.
  3. Record its author, source, and license in ATTRIBUTION.md when known.
  4. Regenerate and validate:
python3 -B scripts/build-index.py
python3 -B scripts/build-site.py

Commit the generated SKILLS.md, skills.sh.json, and README badge changes with the source change. Do not edit those generated sections by hand.

Refresh collected skills

Compare the source with the repository before copying. Include supporting files, and preserve path changes needed by this repository. Keep existing skills unless their removal is part of the requested change.

Record source and license evidence in ATTRIBUTION.md. Exclude private examples, runtime credentials, caches, and machine-specific session bindings. A local snapshot match does not prove upstream freshness.

List the checkout's skills without installing them:

npx skills add . --full-depth --list

Use --full-depth so discovery includes my-skills/ as well as skills/. Check that install instructions include any required companion skills or shared files.

Website changes

site/index.html presents the whole setup. site/skills.html provides the searchable skill catalog. Keep rules, workflows, and OMP configuration visible on the homepage.

Edit site/style.css for shared styles. Edit site/catalog.js for skill search, filters, and copy controls. The builder writes public files to _site/, which Git ignores.

Preview both pages:

python3 -B scripts/build-site.py
python3 -m http.server 8000 --directory _site
  1. Open http://localhost:8000/. Check the setup guide and its source links.
  2. Open http://localhost:8000/skills.html. Check search, category filters, empty results, and copying an install command.
  3. Check both pages with a narrow viewport and keyboard navigation.

Before committing

Run:

python3 -B scripts/build-index.py
python3 -B scripts/build-site.py
python3 -B -m unittest discover -s tests -v
git diff --check

Review the generated diff and any changed source links.

Pull requests run catalog and site checks. The Pages workflow builds the site and uploads only _site/.