diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..fe164de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +description: Report something that is broken or surprising +title: "bug: " +labels: [bug] +--- + +## What happened? + + +## What did you expect to happen? + + +## How can I reproduce it? + + +## Environment + +- pi-ask version: +- pi version: +- Terminal app: +- OS: + +## Change set + +If you already investigated or fixed this, link your fork, branch, or commit here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..75842e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request or change proposal +description: Suggest an idea, improvement, or linked fork change set +title: "feat: " +labels: [enhancement] +--- + +## What would you like to change? + + +## Why does it matter? + + +## Suggested behavior + + +## Change set + +If you already built this, link your fork, branch, or commit here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19dcc24..a6ef6be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,9 +16,17 @@ 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 opening a pull request, run: +Before sharing a change set, please run: ```bash pnpm format @@ -59,10 +67,11 @@ Please keep changes focused: - tests updated when behavior changes materially - docs updated when public behavior or usage changes materially -## Pull requests +## Sharing changes -A good pull request should include: +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 diff --git a/README.md b/README.md index 563c85c..a1204d0 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,12 @@ # @eko24ive/pi-ask [![npm downloads](https://badgen.net/npm/dm/@eko24ive/pi-ask)](https://www.npmjs.com/package/@eko24ive/pi-ask) -[![last commit](https://badgen.net/github/last-commit/eko24ive/pi-ask?v=fa89c15)](https://github.com/eko24ive/pi-ask/commits/main) +[![last commit](https://badgen.net/github/last-commit/eko24ive/pi-ask?v=bbb7017)](https://github.com/eko24ive/pi-ask/commits/main) [![stars](https://badgen.net/github/stars/eko24ive/pi-ask)](https://github.com/eko24ive/pi-ask/stargazers) +> [!IMPORTANT] +> Contributions are welcome in chill mode: please open an issue and link your fork or branch instead of expecting rapid pull-request reviews. + `@eko24ive/pi-ask` is an ask tool that cares about your answers. It lets an agent pause, ask structured questions in a terminal UI, and continue with normalized answers instead of guessing. @@ -14,6 +17,14 @@ It lets an agent pause, ask structured questions in a terminal UI, and continue High-quality video: [demo.mp4](https://github.com/user-attachments/assets/a8503ca9-afcb-4c31-9edc-353b985a0209) +## Contributions: chill mode + +This open source project is something I care about, and it genuinely brings me joy to see it help people. That said, I cannot promise rapid reviews or a normal pull-request turnaround. + +If you have an idea, bug report, or change, please open an issue. If you already have code, link to your fork or branch with the changes. 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 the people who help, whether that means a shout-out, a co-authored commit, or another fitting form of attribution. + ## Install ```bash