From 3dd809201264452e18c17eba1801124d8809aeb8 Mon Sep 17 00:00:00 2001 From: Anbraten Date: Sat, 11 Sep 2021 19:22:38 +0200 Subject: [PATCH] Issue templates (#298) * add new issue templates * adjust labels * blank issues still enabled Co-authored-by: 6543 <6543@obermui.de> --- .github/ISSUE_TEMPLATE/bug_report.yml | 69 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 47 +++++++++++++++ .github/issue_template.md | 0 .github/pull_request_template.md | 0 5 files changed, 124 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/issue_template.md delete mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..07c3b39f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,69 @@ +# Credits to: https://github.com/vitejs/vite/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml +name: "\U0001F41E Bug report" +description: Report an issue with Woodpecker +labels: ["pending:bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: dropdown + id: component + attributes: + label: Component + description: Which component of Woodpecker is affected by the issue? + multiple: true + options: + - server + - agent + - cli + - web-ui + - other + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + - type: textarea + id: system-info + attributes: + label: System Info + description: Output of `https:///version` + render: shell + placeholder: Version info, docker-compose config, Kubernetes manifests + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + description: | + Logs? Screenshots? Anything that will give us more context about the issue you are encountering! + Sometimes a picture is worth a thousand words, but please try not to insert an image of logs / text + and copy paste the text instead. + + Tip: You can attach images by clicking this area to highlight it and then dragging files in. + render: shell + validations: + required: false + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + # - label: Follow our [Code of Conduct](https://github.com/woodpecker-ci/woodpecker/blob/master/CODE_OF_CONDUCT.md) + # required: true + - label: Read the [Contributing Guidelines](https://github.com/woodpecker-ci/woodpecker/blob/master/CONTRIBUTING.md). + required: true + - label: Read the [docs](https://woodpecker-ci.github.io/docs/intro). + required: true + - label: Check that there isn't [already an issue](https://github.com/woodpecker-ci/woodpecker/issues) that reports the same bug to avoid creating a duplicate. + required: true + - label: Check that this is a concrete bug. For Q&A join our [Discord Chat Server](https://discord.gg/fcMQqSMXJy). + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..56bbee810 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Questions & Discussions + url: https://discord.gg/fcMQqSMXJy + about: Ask questions and discuss with other Woodpecker users. + - name: Frequently Asked Questions + url: https://woodpecker-ci.github.io/docs/faq + about: Check the FAQs for common questions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..49788718e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,47 @@ +# Credits to: https://github.com/vitejs/vite/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml +name: "\U0001F680 New feature proposal" +description: Propose a new feature to be added to Woodpecker +labels: ["pending:feature"] +body: + - type: markdown + attributes: + value: | + Thanks for your interest in the project and taking the time to fill out this feature report! + - type: textarea + id: feature-description + attributes: + label: Clear and concise description of the problem + description: "As a user of Woodpecker I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description." + validations: + required: true + - type: textarea + id: suggested-solution + attributes: + label: Suggested solution + description: "In web-ui / config we could provide following functionality..." + validations: + required: true + - type: textarea + id: alternative + attributes: + label: Alternative + description: Clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context or screenshots about the feature request here. + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + # - label: Follow our [Code of Conduct](https://github.com/woodpecker-ci/woodpecker/blob/master/CODE_OF_CONDUCT.md) + # required: true + - label: Read the [Contributing Guidelines](https://github.com/woodpecker-ci/woodpecker/blob/master/CONTRIBUTING.md). + required: true + - label: Read the [docs](https://woodpecker-ci.github.io/docs/intro). + required: true + - label: Check that there isn't already an [issue](https://github.com/woodpecker-ci/woodpecker/issues) that request the same feature to avoid creating a duplicate. + required: true diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index e69de29bb..000000000