Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (50 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 2.29 KB

Contributing

Thanks for contributing.

Principles

  • Keep changes practical and composable.
  • Prefer small, reviewable pull requests.
  • Preserve compatibility with Claude Code workflows.

Repository Structure

  • skills/ contains Claude Code skills (each skill is a directory with SKILL.md).
  • agents/ contains agent persona markdown.
  • commands/ contains slash command prompt files.
  • scripts/ and hooks/ contain shell automation used by this setup.

Pull Requests

  • Explain why the change exists.
  • Include before/after behavior when relevant.
  • Update docs when behavior changes (especially README.md and docs/).

Ways to Contribute

  • Onboarding feedback: if you ran the installer for the first time, report what was confusing or brittle.
  • Docs: clarify adoption paths, presets/flags, or third-party attribution.
  • Skills/agents/commands: fix incorrect guidance, tighten triggers, or add concise examples.
  • Installer hardening: improve conflict handling, manifest uninstall behavior, and dry-run correctness.

Workflow

  • Create a branch from main.
  • Open (or reference) a GitHub issue that explains what you're changing and why.
  • Open a pull request.
  • Keep changes focused (small PRs merge faster).
  • Link the issue in the PR description (e.g. Closes #123 or Refs #123) so the rationale is easy to find later.

Note: main is protected. Direct pushes are blocked and merges require CI to pass.

Local Validation

Run these checks before opening a PR:

# Shell
bash -n install.sh
bash -n hooks/*.sh
bash -n scripts/*.sh

# JSON
python3 -m json.tool settings.json >/dev/null
python3 -m json.tool hooks.json >/dev/null

# Installer smoke test (safe, isolated)
CLAUDE_DIR="/tmp/claude-test" ./install.sh --preset skills --conflict-policy fail
CLAUDE_DIR="/tmp/claude-test" ./install.sh --uninstall

Documentation Expectations

  • Prefer minimal-diff edits.
  • Keep paths and commands copy/pasteable.
  • Avoid introducing non-ASCII characters unless the file already uses them.

Third-Party Content

Some directories are vendored from upstream repositories.

  • If you change vendored content, call it out explicitly in the PR.
  • Prefer contributing improvements upstream when possible.
  • Keep attribution and license notices current (see THIRD_PARTY_NOTICES.md).