From 9a311daed33fef830d157694ac1bc3d174d8bd4d Mon Sep 17 00:00:00 2001 From: Roy Padina <4943097+roypadina@users.noreply.github.com> Date: Fri, 23 Oct 2026 23:11:43 +0300 Subject: [PATCH] docs: feature requests and contributions (supporters first) --- .github/ISSUE_TEMPLATE/feature_request.yml | 20 ++++++++++++++++---- CONTRIBUTING.md | 9 ++++++--- README.md | 9 +++++++++ 3 files changed, 31 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 82ec595..1148126 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -5,17 +5,29 @@ body: - type: textarea id: problem attributes: - label: Problem / motivation - description: What are you trying to do that Agentctl doesn't support today? + label: What are you trying to do? + description: The situation where Agentctl gets in the way or falls short. This matters more than the exact feature. validations: required: true - type: textarea id: proposal attributes: - label: Proposed solution + label: What would you like Agentctl to do? validations: required: true - type: textarea id: alternatives attributes: - label: Alternatives considered + label: Workarounds or alternatives you've tried + - type: input + id: kofi + attributes: + label: Ko-fi supporter? (optional) + description: Your Ko-fi name, if you've tipped. Supporter requests go to the front of the queue. It's a thank-you, not a purchase, so no promise on what ships or when. This field is public; skip it if you'd rather not say. + placeholder: Ko-fi name + - type: checkboxes + id: pr + attributes: + label: Would you build it? + options: + - label: I'd be up for sending a pull request for this. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d799a4a..73ad5d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,10 @@ See [`CLAUDE.md`](CLAUDE.md) for the full module map and conventions. 4. Commit with a clear message and open a **Pull Request** against `main`. 5. CI must be green and the maintainer must approve before merge. -## Reporting bugs / requesting features +## Feature requests and bugs -Use the [issue templates](https://github.com/roypadina/Agentctl/issues/new/choose). For bugs, -include your macOS + Node versions and how you launched it. +- **Feature requests:** [open one](https://github.com/roypadina/Agentctl/issues/new?template=feature_request.yml) and say what you're trying to do; that matters more than the exact feature. Search the [open requests](https://github.com/roypadina/Agentctl/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) first and 👍 an existing one if it's there. +- **Bugs:** use the [bug report](https://github.com/roypadina/Agentctl/issues/new?template=bug_report.yml); include your macOS + Node versions and how you launched it. +- **Ko-fi supporters:** add your Ko-fi name to the request and it goes to the front of my queue. It's a thank-you, not a purchase: no promise on what ships or when. +- **Bigger changes:** open an issue before the PR so we agree on the shape first. Small, focused PRs can come straight in. +- Replies are best effort, evenings and weekends. I read everything. diff --git a/README.md b/README.md index 7002c77..317e6cf 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ your terminal as **`agentctl`**. - [Is it safe?](#is-it-safe) - [Uninstall](#uninstall) - [Contributing](#contributing) +- [Feature requests and contributions](#feature-requests-and-contributions) - [Support](#support) - [License](#license) @@ -312,6 +313,14 @@ PRs welcome! `main` is protected — fork, branch, add tests, and open a PR. See npm test && npm run typecheck && npm run build # the whole check ``` +## Feature requests and contributions + +Have an idea for Agentctl? [Request a feature](https://github.com/roypadina/Agentctl/issues/new?template=feature_request.yml) and say what you're trying to do; that matters more than the exact feature. Found a bug? [Report it](https://github.com/roypadina/Agentctl/issues/new?template=bug_report.yml). + +See [CONTRIBUTING.md](CONTRIBUTING.md). + +Tipped on [Ko-fi](https://ko-fi.com/roypadina)? Add your Ko-fi name to the request and it goes to the front of my queue. It's a thank-you, not a purchase: no promise on what ships or when. + ## More Mac apps by Roy Free, open-source Mac menu-bar apps and terminal tools, all on one site: **[apps.roypadina.synology.me](https://apps.roypadina.synology.me/)**.