Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (43 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 1.36 KB

Contributing

Thanks for contributing to putio-cli.

Setup

Use the Node version required by package.json, then install dependencies:

vp install

Then install the stock VitePlus hook wiring for this clone:

vp config

Run Locally

Start the local build watcher:

pnpm run dev

Build the CLI once and try the shipped entrypoint:

pnpm run build
./dist/bin.mjs describe

Validation

Run the main repository gate before opening or updating a pull request:

pnpm run verify

Run focused checks when they match your change:

pnpm run smoke:pack
pnpm run build:sea
pnpm run verify:sea

Development Notes

  • verify is the repository delivery gate.
  • Prefer vp install, vp test, and vp check for day-to-day local loops.
  • Keep top-level user docs in README.md and contributor workflow here.
  • Put deeper implementation detail in docs/ instead of growing the top-level docs.
  • Keep AGENTS.md as repo-development guidance and skills/* as consumer-facing agent guidance.
  • When the public CLI surface or agent setup flow changes, update README.md and skills/putio-cli/* in the same change.

Pull Requests

  • Keep changes focused and explicit.
  • Add or update tests when behavior changes.
  • Prefer small follow-up pull requests over mixing unrelated cleanup into one branch.