Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (26 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.37 KB
Raw

Contributing to Skill Graph

Thanks for contributing to Skill Graph.

Development setup

  1. Install Node 20+ and npm 10+.
  2. Run npm install.
  3. Run npm test, npm run lint, and npm run build before opening a pull request.

Project layout

  • apps/web: browser UI
  • apps/server: local API
  • packages/core: shared schema, workspace loading, preview, and validation logic
  • skills/skill-graph-generator: bundled standalone generator skill
  • sample-skills: sample skills used for local validation

Contribution expectations

  • Keep the 2.0 action-flow schema as the single source of truth.
  • Do not add compatibility layers for old graph formats unless they are explicitly planned.
  • Prefer small, isolated modules over growing controller-style files.
  • Add or update tests whenever behavior or contracts change.
  • Keep sample skills safe to inspect locally. If a sample demonstrates risky behavior, document that clearly.

Pull requests

  • Explain the problem first, then the chosen fix.
  • Call out schema, API, or sample-skill changes explicitly.
  • Include screenshots for meaningful canvas or UI changes.

Code style

  • TypeScript is strict; do not weaken compiler settings to land a change.
  • Avoid dead code, speculative abstractions, and duplicate data-contract logic across layers.
  • Reuse shared packages/core types instead of redefining them in app packages.