From 7b4ac54171ac0b466de6205246568f416a6e97e9 Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Fri, 10 Apr 2026 15:08:12 -0700 Subject: [PATCH] chore: use rendered issue templates Co-Authored-By: Claude --- .github/ISSUE_TEMPLATE/00-question.yml | 61 ++++++++++++++++++ .github/ISSUE_TEMPLATE/01-bug.yml | 71 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/01_question.md | 53 --------------- .github/ISSUE_TEMPLATE/02-feature.yml | 30 +++++++++ .github/ISSUE_TEMPLATE/02_enhancement.md | 17 ----- .github/ISSUE_TEMPLATE/03-documentation.yml | 29 +++++++++ .github/ISSUE_TEMPLATE/03_documentation.md | 17 ----- .github/ISSUE_TEMPLATE/04_bug.md | 53 --------------- .github/ISSUE_TEMPLATE/config.yml | 7 ++ .github/issue_template.md | 18 ------ 10 files changed, 198 insertions(+), 158 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/00-question.yml create mode 100644 .github/ISSUE_TEMPLATE/01-bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/01_question.md create mode 100644 .github/ISSUE_TEMPLATE/02-feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/02_enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/03-documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/03_documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/04_bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/00-question.yml b/.github/ISSUE_TEMPLATE/00-question.yml new file mode 100644 index 00000000..53f998e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-question.yml @@ -0,0 +1,61 @@ +name: CLI Question +description: Submit a question about the Slack CLI +labels: ["untriaged"] +body: + - type: markdown + attributes: + value: | + Have a question about using the Slack CLI? We're here to help! + + - type: textarea + id: question + attributes: + label: Question + description: Describe your question in detail + validations: + required: true + + - type: input + id: cli-version + attributes: + label: CLI Version + description: Run `slack --version` + placeholder: e.g., slack-cli/2.35.0 + + - type: input + id: os + attributes: + label: Operating System + description: | + macOS/Linux: `sw_vers && uname -v` or Windows: `ver` + placeholder: e.g., macOS 14.0, Ubuntu 22.04, Windows 11 + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Share commands, source code, and project settings + placeholder: | + 1. Run `slack ...` + 2. ... + 3. ... + + - type: textarea + id: expected + attributes: + label: Expected Result + description: What did you expect to happen? + + - type: textarea + id: actual + attributes: + label: Actual Result + description: What actually happened? Include logs, screenshots, or error messages. + + - type: markdown + attributes: + value: | + --- + For general questions about the Slack API platform, please [contact Slack support](https://slack.com/help/requests/new). + + By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/slackapi/slack-cli/blob/main/.github/CONTRIBUTING.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct). diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml new file mode 100644 index 00000000..fbfe898b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug.yml @@ -0,0 +1,71 @@ +name: CLI Bug +description: Report a CLI bug +labels: ["untriaged"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report! + + - type: input + id: cli-version + attributes: + label: CLI Version + description: Run `slack --version` + placeholder: e.g., slack-cli/2.35.0 + validations: + required: true + + - type: input + id: os + attributes: + label: Operating System + description: | + macOS/Linux: `sw_vers && uname -v` or Windows: `ver` + placeholder: e.g., macOS 14.0, Ubuntu 22.04, Windows 11 + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Describe the bug in detail + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Share commands, source code, and project settings + placeholder: | + 1. Run `slack ...` + 2. ... + 3. See error... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Result + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Result + description: What actually happened? Include logs, screenshots, or error messages. + validations: + required: true + + - type: markdown + attributes: + value: | + --- + For general questions about the Slack API platform, please [contact Slack support](https://slack.com/help/requests/new). + + By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/slackapi/slack-cli/blob/main/.github/CONTRIBUTING.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct). diff --git a/.github/ISSUE_TEMPLATE/01_question.md b/.github/ISSUE_TEMPLATE/01_question.md deleted file mode 100644 index 5a42491c..00000000 --- a/.github/ISSUE_TEMPLATE/01_question.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -name: Question -about: Submit a question about this project -title: (Set a clear title describing your question) -labels: 'untriaged' -assignees: '' ---- - -### Question - -(Ask your question in as much detail as possible) - -### Version - -Please paste the output from: - -```zsh -slack --version -``` - -### OS Info - -Please paste the output from: - -```zsh -# Run this command on macOS/Linux -sw_vers && uname -v - -# Run this command on Windows -ver -``` - -#### Steps to reproduce: - -Share the commands to run, source code, and project settings: - -1. -2. -3. - -### Expected result: - -(Tell what you expected to happen) - -### Actual result: - -(Tell what actually happened with logs, screenshots) - -### Requirements - -* [ ] I've read and understood the [Contributing guidelines](/blob/main/.github/contributing.md) and have done my best effort to follow them. -* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct). -* [ ] I've searched for any related issues and avoided creating a duplicate issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02-feature.yml b/.github/ISSUE_TEMPLATE/02-feature.yml new file mode 100644 index 00000000..20b23ec1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature.yml @@ -0,0 +1,30 @@ +name: CLI Enhancement / Feature Request +description: Submit an enhancement or feature request +labels: ["untriaged"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting an improvement! + + - type: textarea + id: description + attributes: + label: Description + description: Describe the enhancement or feature you'd like + placeholder: | + Tell us about your idea! What would you like to see, and how would it help? + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or workarounds? + + - type: markdown + attributes: + value: | + --- + By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/slackapi/slack-cli/blob/main/.github/CONTRIBUTING.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct). diff --git a/.github/ISSUE_TEMPLATE/02_enhancement.md b/.github/ISSUE_TEMPLATE/02_enhancement.md deleted file mode 100644 index 42df630e..00000000 --- a/.github/ISSUE_TEMPLATE/02_enhancement.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Enhancement / Feature Request -about: Submit an enhancement/feature request -title: (Set a clear title describing your idea) -labels: 'untriaged' -assignees: '' ---- - -### Description - -(Describe your enhancement or feature request here) - -### Requirements - -* [ ] I've read and understood the [Contributing guidelines](/blob/main/.github/contributing.md) and have done my best effort to follow them. -* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct). -* [ ] I've searched for any related issues and avoided creating a duplicate issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03-documentation.yml b/.github/ISSUE_TEMPLATE/03-documentation.yml new file mode 100644 index 00000000..b02f863a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-documentation.yml @@ -0,0 +1,29 @@ +name: CLI Documentation +description: Submit an issue about documentation +labels: ["untriaged", "docs"] +body: + - type: markdown + attributes: + value: | + Found an issue with the documentation? Let us know! + + - type: textarea + id: description + attributes: + label: Description + description: Describe the documentation issue or improvement + validations: + required: true + + - type: input + id: url + attributes: + label: Relevant URL + description: Link to the documentation page (if applicable) + placeholder: e.g., https://docs.slack.dev/tools/slack-cli/ + + - type: markdown + attributes: + value: | + --- + By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/slackapi/slack-cli/blob/main/.github/CONTRIBUTING.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct). diff --git a/.github/ISSUE_TEMPLATE/03_documentation.md b/.github/ISSUE_TEMPLATE/03_documentation.md deleted file mode 100644 index 26597541..00000000 --- a/.github/ISSUE_TEMPLATE/03_documentation.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Documentation -about: Submit an issue about documentation -title: (Set a clear title describing your idea) -labels: 'untriaged' -assignees: '' ---- - -### Description - -(Describe your issue and enhancement here) - -### Requirements - -* [ ] I've read and understood the [Contributing guidelines](/blob/main/.github/contributing.md) and have done my best effort to follow them. -* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct). -* [ ] I've searched for any related issues and avoided creating a duplicate issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/04_bug.md b/.github/ISSUE_TEMPLATE/04_bug.md deleted file mode 100644 index d03da226..00000000 --- a/.github/ISSUE_TEMPLATE/04_bug.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -name: Bug -about: Report an issue or bug -title: (Set a clear title describing the issue) -labels: 'untriaged' -assignees: '' ---- - -### Description - -(Describe your bug or issue in as much detail as possible) - -### Version - -Please paste the output from: - -```zsh -slack --version -``` - -### OS Info - -Please paste the output from: - -```zsh -# Run this command on macOS/Linux -sw_vers && uname -v - -# Run this command on Windows -ver -``` - -#### Steps to reproduce: - -Share the commands to run, source code, and project settings: - -1. -2. -3. - -### Expected result: - -(Tell what you expected to happen) - -### Actual result: - -(Tell what actually happened with logs, screenshots) - -### Requirements - -* [ ] I've read and understood the [Contributing guidelines](/blob/main/.github/contributing.md) and have done my best effort to follow them. -* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct). -* [ ] I've searched for any related issues and avoided creating a duplicate issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..01167ea5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +blank_issues_enabled: false +contact_links: + - name: Slack Platform Customer Support + url: https://slack.com/help/requests/new + about: | + This issue tracker is for bugs, feature requests, and questions about the Slack CLI. + If you have a general question about the Slack platform, please contact our support team via /feedback in your Slack workspace or the help page linked here. diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index d92b3ec9..00000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,18 +0,0 @@ -### Description - -Describe your issue here. - -### What type of issue is this? - -- [ ] bug -- [ ] enhancement (feature request) -- [ ] question -- [ ] documentation related -- [ ] testing related -- [ ] discussion - -### Requirements - -* [ ] I've read and understood the [Contributing guidelines](/blob/main/.github/contributing.md) and have done my best effort to follow them. -* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct). -* [ ] I've searched for any related issues and avoided creating a duplicate issue. \ No newline at end of file