mirror of
https://github.com/magnus919/agent-skills.git
synced 2026-09-21 00:26:23 +03:00
Magnus HedemarkandGitHub
fc8a8952ee
Wire the Phase 3 ratchet into CI by passing the PR base SHA to eval-coverage.py --modified-from. Expand changed-skill detection from SKILL.md-only diffs to the entire skill directory so that references, scripts, fixtures, README, and eval manifest edits all count as modifications. Add a monotonic coverage floor that fails CI when coverage decreases between the base and candidate revisions. Add script tests for ratchet-mode detection and coverage-decrease behaviour. Update AGENTS.md and CONTRIBUTING.md to describe the behaviour CI now enforces. Closes #102 Signed-off-by: Magnus Hedemark <magnus919@pm.me>
69 lines
3.8 KiB
Markdown
69 lines
3.8 KiB
Markdown
# Contributing to agent-skills
|
|
|
|
Thanks for helping improve agent-skills. Contributions should make a skill more useful, more portable, or easier for humans and agents to discover.
|
|
|
|
## Before you start
|
|
|
|
- Read `AGENTS.md` for repository-wide conventions.
|
|
- Read the target skill's `SKILL.md` and `README.md` before changing it.
|
|
- For a new skill or a substantial change, open an issue first so the scope can be discussed.
|
|
- Do not include credentials, private infrastructure details, or deployment-specific paths.
|
|
|
|
## Skill requirements
|
|
|
|
Each skill must:
|
|
|
|
- Live in its own directory with a matching lowercase, hyphenated name.
|
|
- Include `SKILL.md` with valid YAML frontmatter.
|
|
- Include a human-facing `README.md` with the required sections described in `AGENTS.md`.
|
|
- Keep core instructions concise and put deeper material in `references/`, `templates/`, or `scripts/`.
|
|
- Use relative links that work from a fresh clone.
|
|
- Use an imperative-verb description that defines both positive and negative trigger boundaries.
|
|
- Describe when the skill should be loaded, and identify the nearest alternative when overlap matters.
|
|
- Include `evals/evals.json` with at least five representative output-quality cases for every new skill. Existing skills are grandfathered via `scripts/grandfathered-skills.txt`; the ratchet tightens as overall coverage climbs. The ratchet runs in CI on every pull request via `python3 scripts/eval-coverage.py --modified-from <base-sha>`. A skill counts as modified when any tracked file under its directory changes. Coverage must not decrease between the base revision and the candidate.
|
|
|
|
## Development
|
|
|
|
Clone the repository and run the validators from its root:
|
|
|
|
```sh
|
|
git clone https://github.com/magnus919/agent-skills.git
|
|
cd agent-skills
|
|
ruby scripts/validate-skills.rb
|
|
ruby scripts/validate-skill-quality.rb --base origin/main
|
|
python3 scripts/eval-coverage.py
|
|
```
|
|
|
|
The structural validator checks the whole repository. The quality validator checks only added, renamed, modified, or uncommitted `SKILL.md` files relative to the supplied base. Changed descriptions must begin with an imperative verb and define a negative boundary in the description or a `When not to use` section. Generic no-op instructions are reported as warnings. The same validation runs in GitHub Actions for pushes and pull requests.
|
|
|
|
This repository also tracks generated catalog files. CI validates their freshness but does not regenerate them. If a check reports a stale artifact, regenerate locally:
|
|
|
|
```sh
|
|
ruby scripts/gen-claude-marketplace.rb --write
|
|
ruby scripts/gen-codex-plugin.rb --write
|
|
ruby scripts/gen-llms-txt.rb --write
|
|
```
|
|
|
|
Each generator also runs in check mode (without `--write`) to verify freshness.
|
|
|
|
If a skill includes executable scripts or a package, run its documented checks as well and include the commands and results in your pull request.
|
|
|
|
## Deprecating a skill
|
|
|
|
When replacing a skill, preserve its old directory as a routing stub. Prefix its description with `Deprecated: use <replacement>`, explain the migration in the stub, and remove it only after compatibility is no longer required.
|
|
|
|
## Pull requests
|
|
|
|
- Create a branch from `main`: `feat/short-description`, `fix/short-description`, or `docs/short-description`.
|
|
- Keep each pull request focused on one logical change.
|
|
- Use a clear Conventional Commit subject, such as `feat(skill): add ...` or `fix(skill): ...`.
|
|
- Add or update documentation with the behavior it describes.
|
|
- Do not force-push after review unless a maintainer asks you to.
|
|
- Complete the pull request checklist and disclose meaningful AI assistance.
|
|
|
|
A maintainer may ask for an issue before reviewing a large design change. Small documentation fixes and clear bug fixes can go directly to a pull request.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contribution is released under the MIT License in this repository.
|