Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.34 KB
Raw

Contributing

Thanks for considering. This is a small, opinionated project — keep PRs focused.

Dev setup

git clone <fork>
cd <repo>
npm install
npm i -g backlog.md      # peer requirement
chmod +x bin/taskpile bin/taskpile-*

Use the hub itself as a tracked project (taskpile init .) to dogfood changes.

Conventions

  • Node 18+, no TypeScript (keep deps small).
  • Two prod deps: gray-matter, js-yaml. Keep it that way.
  • Backlog.md is the only required peer.
  • All scripts under bin/ should be executable + start with #!/usr/bin/env node.

What's in scope

  • Tooling around Backlog.md (aggregation, indexing, capability discovery).
  • Skill files + conventions for AI tool integration.
  • Recipe / routine patterns.

What's out of scope (for now)

  • Building a new ticket format (Backlog.md is the chosen substrate).
  • Real-time multi-user sync.
  • Web/SaaS deployment.
  • Auth.

If you want one of these — start a discussion before opening a PR.

PR checklist

  • Updated CHANGELOG.md.
  • If adding a CLI command, updated bin/taskpile dispatcher and README.
  • If adding a skill section, updated both global skill and any sample project skill.
  • Smoke test: taskpile init <tmpdir> works end-to-end on a fresh project.

Architecture decisions

See backlog/decisions/ for ADRs and docs/ for design notes.