From 60dfdf380646a794a599f69db0f41bd7b17a42c6 Mon Sep 17 00:00:00 2001 From: Owen Qwen Date: Wed, 24 Jun 2026 20:57:00 -0500 Subject: [PATCH] Add GitHub issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 101 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/docs.yml | 44 +++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 59 ++++++++++++ .github/ISSUE_TEMPLATE/task.yml | 52 +++++++++++ 5 files changed, 261 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/task.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..2c63e6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,101 @@ +name: Bug report +description: Report a reproducible problem with Cassady / cass +title: "bug: " +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug. Please include enough detail for someone to reproduce it. + - type: textarea + id: summary + attributes: + label: Summary + description: What went wrong? + placeholder: Cassady crashes when... + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: List the exact commands, key presses, or config changes needed to trigger the issue. + placeholder: | + 1. Run `cass ...` + 2. Press ... + 3. See ... + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What happened instead? Paste errors, logs, or terminal output when useful. + render: text + validations: + required: true + - type: input + id: version + attributes: + label: Cassady version + description: Output of `cass --version` or `cassady --version`. + placeholder: cassady 0.2.x + validations: + required: true + - type: dropdown + id: install + attributes: + label: Install method + options: + - Release archive + - cargo install --git + - cargo install --path / local build + - Other + validations: + required: true + - type: dropdown + id: platform + attributes: + label: Platform + options: + - macOS Apple Silicon + - macOS Intel + - Linux x86_64 + - Linux ARM64 + - Windows x86_64 + - Other + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment details + description: Terminal, shell, provider/model, access mode, and anything notable from `cass check`. Do not include API keys. + placeholder: | + Terminal: ... + Shell: ... + Provider/model: ... + Access mode: ... + `cass check`: ... + - type: textarea + id: config + attributes: + label: Relevant configuration + description: Paste sanitized snippets from `~/.cass/config.json`, `providers.json`, or `models.json` if relevant. Remove API keys and secrets. + render: json + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I removed API keys, tokens, and other secrets from this report. + required: true + - label: I searched existing issues for a duplicate. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..baddc95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions and usage help + url: https://github.com/owenqwenstarsky/cassady/discussions + about: Ask questions, share setup notes, or discuss ideas before filing an issue. diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 0000000..a3a9d9a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,44 @@ +name: Documentation issue +description: Report missing, confusing, or incorrect documentation +title: "docs: " +labels: [documentation] +body: + - type: textarea + id: location + attributes: + label: Documentation location + description: Link to the page or name the file/section, if known. + placeholder: README.md, docs/providers.md, docs/access-modes.md, ... + validations: + required: true + - type: textarea + id: issue + attributes: + label: What is unclear or incorrect? + description: Describe the gap, mistake, or confusing wording. + validations: + required: true + - type: textarea + id: suggested + attributes: + label: Suggested improvement + description: If you have specific wording or examples in mind, add them here. + - type: dropdown + id: impact + attributes: + label: Impact + options: + - Blocks installation or first use + - Causes incorrect configuration + - Confuses normal usage + - Typo or small polish + - Other + validations: + required: true + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I searched existing issues for a duplicate. + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..54e8313 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,59 @@ +name: Feature request +description: Suggest an improvement or new capability for Cassady / cass +title: "feat: " +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting an improvement. Please focus on the user problem and desired outcome. + - type: textarea + id: problem + attributes: + label: Problem or use case + description: What are you trying to do, and what makes it hard today? + placeholder: I want to... + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed behavior + description: Describe the change you would like to see. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: What workarounds or other designs have you considered? + - type: dropdown + id: area + attributes: + label: Area + options: + - Terminal UI + - Setup and configuration + - Providers and models + - Tools and file editing + - Safety and access modes + - Conversation history and resume + - Documentation + - Packaging and releases + - Other + validations: + required: true + - type: textarea + id: examples + attributes: + label: Examples or mockups + description: Add sample commands, UI text, config snippets, screenshots, or links that clarify the request. + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I searched existing issues for related requests. + required: true + - label: This request is in scope for a terminal coding agent, not a general package manager or updater. + required: false diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000..9f464f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,52 @@ +name: Maintenance task +description: Track internal cleanup, refactoring, testing, CI, or release work +title: "chore: " +labels: [maintenance] +body: + - type: textarea + id: goal + attributes: + label: Goal + description: What should be done, and why? + validations: + required: true + - type: textarea + id: scope + attributes: + label: Scope + description: List concrete files, modules, or workflows that are in scope. + placeholder: | + - src/... + - tests/... + - .github/workflows/... + validations: + required: true + - type: textarea + id: out_of_scope + attributes: + label: Out of scope + description: Note anything this task should intentionally avoid. + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + description: What must be true before this can be closed? + placeholder: | + - [ ] ... + - [ ] `cargo test --locked --all-targets` passes + validations: + required: true + - type: dropdown + id: area + attributes: + label: Area + options: + - Refactoring + - Tests + - CI + - Release process + - Dependencies + - Documentation maintenance + - Other + validations: + required: true