Contributing

July 22, 2026 ยท View on GitHub

Thanks for helping grow the Claude Code Artifacts library. This guide covers how to add an artifact, the conventions each type follows, and the quality gate your change must pass.

Ways to contribute

Add a new artifact under the matching <type>/library/ directory following that type's README, run the quality gate, and open a pull request. Every artifact here is maintained through pull requests.

Where each artifact goes

Follow the README inside each type directory for the exact layout and naming:

TypeLocationRead first
Skillskills/library/<skill-name>/SKILL.mdskills/README.md
Hookhooks/library/*.py (+ hooks/configs/universal/*.yaml)hooks/README.md
Rulerules/library/*.mdrules/README.md
Environment configurationenvironments/library/*.yaml (+ environments/templates/)environments/README.md
Agentagents/library/*.mdagents/README.md
Slash commandslash-commands/library/*.mdslash-commands/README.md

Local setup

This repository uses uv for dependency management and pre-commit for the quality gate.

uv sync
uv run pre-commit install

Quality gate

Run the full gate before opening a pull request:

uv run pre-commit run --all-files

This runs Ruff, Mypy, Pyright, and ty on Python hooks, Markdown linting, XML-tag validation on skill and agent Markdown, JSON/YAML syntax checks, and lock-file freshness.

For environment configurations, validate against the schema (this also runs in CI on pull requests):

uv run python .github/validate_configs.py environments/library --strict

Commits and pull requests

  • This repository uses Conventional Commits (enforced by commitizen). Example: feat: add code-review skill.
  • Keep each pull request focused on one artifact or one coherent change.
  • Never include secrets. Review your artifact's runtime behavior โ€” hooks and environment configurations execute on a user's machine.