From 2c5b233ea7c8564323d020bd6d1d5334989f29b5 Mon Sep 17 00:00:00 2001 From: Cassidy James Date: Tue, 2 Jun 2026 16:48:38 -0600 Subject: [PATCH] Add issue forms (#674) * issue template: add bug.yml Progress towards https://github.com/roostorg/coop/issues/673 * issue templates: Add config Work towards https://github.com/roostorg/coop/issues/673 * issue template: quote Discord about accidentally a comment * issue templates: disallow blank issues from non-maintainers * issue templates: add feature.yml Progress on https://github.com/roostorg/coop/issues/673 * issue templates: remove contact info I don't want to encourage people to share their contact info, and ideally we can stick to GitHub; it sends emails for notifications, so it should be accessible! --- .github/ISSUE_TEMPLATE/bug.yml | 89 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 +++ .github/ISSUE_TEMPLATE/feature.yml | 75 +++++++++++++++++++++++++ 3 files changed, 173 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..04457da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,89 @@ +name: Report a bug +description: Something is broken or not working correctly +type: bug +body: + - type: markdown + attributes: + value: > + Thanks for taking the time to report a bug in Coop! **Please provide as + much detail as you can** so we can properly confirm, triage, and + ultimately fix your bug. + + - type: textarea + id: behavior + attributes: + label: What happened + description: > + …and what did you expect to happen, instead? + placeholder: On the Review Console page, when I click on… + validations: + required: true + + - type: input + id: version + attributes: + label: Version/commit + description: > + What version of Coop are you running? If you’re not sure, leave it blank. + If you know the specific commit, include it here. + validations: + required: false + + - type: dropdown + id: browsers + attributes: + label: Affected browser(s) + description: > + Which browser(s) are you seeing the problem in? Leave blank if it's not + a front-end issue. If an affected browser is not included in this list, + mention it below. + multiple: true + options: + - Chrome + - Firefox + - Microsoft Edge + - Safari + + - type: textarea + id: logs + attributes: + label: Relevant logs/errors + description: > + Please paste any relevant log output or error messages. + render: shell + validations: + required: false + + - type: textarea + id: extra + attributes: + label: Anything else + description: > + Share any other information that could be helpful in reproducing, + triaging, or fixing your bug. + validations: + required: false + + - type: upload + id: screenshots + attributes: + label: Screenshots + description: > + If applicable, add screenshots to help explain your problem. + **Please redact sensitive information** such as user content or personal + details before uploading. Do not share content that violates GitHub’s + [acceptable use policies](https://docs.github.com/en/site-policy/acceptable-use-policies). + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: > + Make sure you’ve completed each step and reviewed the + [Code of Conduct](https://github.com/roostorg/.github/blob/main/CODE_OF_CONDUCT.md) + before submitting. + options: + - label: I’ve reviewed and agree to follow the code of conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..c8fda80 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +blank_issues_enabled: false # maintainers can still file blank issues for convenience +contact_links: + - name: Discuss Coop + about: "See previously-asked questions and existing discussions about Coop, or start your own" + url: https://github.com/roostorg/coop/discussions + + - name: Chat with contributors + about: "Join the #coop channel on the ROOST Discord server" + url: https://discord.gg/2r7uUqvsut diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..b740d22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,75 @@ +name: Request a feature +description: An idea or new functionality +type: feature +body: + - type: markdown + attributes: + value: > + Thanks for taking the time to request a feature for Coop! **Please + provide as much detail as you can** so we can fully understand, triage, + address your request. + + - type: textarea + id: problem + attributes: + label: Problem being solved + description: > + What is the underlying thing you’re hoping is addressed by this feature? + placeholder: Our organization requires… + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: > + How do you imagine this feature would look or work? + placeholder: On the Review Console page, there should be… + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: > + What other possible solutions or features have you considered that would + address this? + placeholder: Admins could set this behavior, but… + validations: + required: true + + - type: textarea + id: extra + attributes: + label: Anything else + description: > + Share any other information that could be helpful in understanding, + triaging, or addressing your request. + validations: + required: false + + - type: upload + id: screenshots + attributes: + label: Screenshots + description: > + If applicable, add screenshots or designs to help explain your request. + **Please redact sensitive information** such as user content or personal + details before uploading. Do not share content that violates GitHub’s + [acceptable use policies](https://docs.github.com/en/site-policy/acceptable-use-policies). + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: > + Make sure you’ve completed each step and reviewed the + [Code of Conduct](https://github.com/roostorg/.github/blob/main/CODE_OF_CONDUCT.md) + before submitting. + options: + - label: I’ve reviewed and agree to follow the code of conduct + required: true -- 2.51.2