Contributing

Thanks for contributing to @eko24ive/pi-ask.

Development setup

Install dependencies:

pnpm install

Run the extension locally:

pi -e ./src/index.ts

Contribution flow: chill mode

This project is open source because I care about it, and it makes me happy when it helps people. I still cannot promise rapid reviews or a traditional pull-request turnaround.

Please open an issue for ideas, bugs, and proposed changes. If you already have code, link to your fork or branch with the change set. I will review it carefully when I have time, then either incorporate the forked changes or implement the idea myself.

I value contributions and will do my best to credit helpful work with a shout-out, a co-authored commit, or another fitting form of attribution.

Validation

Before sharing a change set, please 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

A useful issue with a linked fork should include:

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

1.7 KiB Raw Permalink Blame History