Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (24 loc) · 707 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 707 Bytes
Raw

Contributing

Thanks for helping improve gitwork.

Setup

npm install
npm test
npm run build

Node 20+.

Guidelines

  • Keep the default path AI-free (no required LLM keys).
  • Prefer GitHub-native surfaces (Issues, PRs, Discussions, status).
  • Add unit tests for pure logic (src/lib/*).
  • Dry-run flags should never write to GitHub.

Commands layout

  • src/commands/ooo.ts — out of office
  • src/commands/today.ts — work desk
  • src/commands/path.ts — dependency critical path
  • src/lib/graph.ts — waves / unlock scores
  • action/* — composite Actions

PR checklist

  • npm test passes
  • npm run build passes
  • README updated if UX changed