pi-ask/CONTRIBUTING.md

Contributing

Thanks for contributing to @eko24ive/pi-ask.

Development setup

Install dependencies:

pnpm install

Run the extension locally:

pi -e ./src/index.ts

Validation

Before opening a pull request, run:

pnpm format
pnpm typecheck
pnpm test

You can also run the repo-wide check:

pnpm check

Commit messages

This repo uses conventional commits and semantic-release.

Recommended flow:

pnpm commit

Examples:

• feat: add preview question footer hint
• fix: preserve option notes when toggling selection
• docs: clarify npm install flow

Conventional commit types matter because releases are generated automatically from commit history.

Scope of changes

Please keep changes focused:

• state logic in plain TypeScript modules
• pi/TUI wiring thin
• tests updated when behavior changes materially
• docs updated when public behavior or usage changes materially

Pull requests

A good pull request should include:

• a clear summary of the change
• tests for behavior changes
• docs updates when user-facing behavior changes