Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (36 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 1.57 KB

Contributing to Cascades

Thanks for contributing.

cascades is a public repository for reusable Claude Code skills. Contributions should make the repository more portable, better documented, and easier to use across environments.

Core rules

  • Keep all contributions customer-agnostic.
  • Do not commit generated outputs from real environments.
  • Do not commit credentials, auth artifacts, cached exports, or local paths.
  • Prefer read-only access patterns unless a skill explicitly requires broader permissions.
  • Add or update documentation whenever behavior changes.

Skill requirements

Each public skill should include:

  • SKILL.md
  • README.md
  • agents/ when agent configuration is needed
  • references/ for supporting docs
  • scripts/ for reusable helpers

Examples and commands must use synthetic placeholders such as example.com.

Sensitive data that must stay out of the repo

Do not commit:

  • reports/
  • outputs/
  • sessions/
  • auth_status.json
  • *.ndjson
  • *.csv
  • *.err
  • real tenant names or user emails
  • real OAuth client IDs from customer environments

Workflow

  1. Create a branch from main.
  2. Make the change.
  3. Verify no caches or generated artifacts were added.
  4. Run a quick content scan for customer data before opening a PR.
  5. Open a pull request with a short explanation of the change and how it was validated.

Adding new skill families later

Future skill categories can be added under .claude/skills/ without restructuring the repository. Keep each new skill self-contained and documented so the repo can grow incrementally.