From 20915dc1bf9378587bb2fa88664519b48c30d006 Mon Sep 17 00:00:00 2001 From: Kwonunn Date: Sat, 19 Oct 2024 14:58:44 +0200 Subject: [PATCH] chore: add issue templates --- .forgejo/issue_template/bug-report.yaml | 84 ++++++++++++++++++++ .forgejo/issue_template/feature-request.yaml | 26 ++++++ 2 files changed, 110 insertions(+) create mode 100644 .forgejo/issue_template/bug-report.yaml create mode 100644 .forgejo/issue_template/feature-request.yaml diff --git a/.forgejo/issue_template/bug-report.yaml b/.forgejo/issue_template/bug-report.yaml new file mode 100644 index 0000000..414f4e4 --- /dev/null +++ b/.forgejo/issue_template/bug-report.yaml @@ -0,0 +1,84 @@ +name: 🐛 Bug Report +description: Found something you weren't expecting? Report it here! +title: "bug: " +labels: ["Kind/Bug"] +body: + - type: markdown + attributes: + value: | + **NOTE: If your issue is a security concern, please email (GPG: `A4676E79`) instead of opening a public issue.** + - type: markdown + attributes: + value: | + - Please speak English, as this is the language all maintainers can speak and write. + - Be as clear and concise as possible. A very verbose report is harder to interpret in a concrete way. + - Be civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct). + - Take a moment to [check that your issue hasn't been reported before](https://code.forgejo.org/forgejo/runner/issues?q=&type=all&labels=19). + - type: dropdown + id: can-reproduce + attributes: + label: Can you reproduce the bug on the Forgejo test instance? + description: | + Please try reproducing your issue at https://dev.next.forgejo.org. + It is running the latest development branch and will confirm the problem is not already fixed. + If you can reproduce it, provide a URL in the description. + options: + - "Yes" + - "No" + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: | + Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see above). + validations: + required: true + - type: input + id: forgejo-ver + attributes: + label: Forgejo Version + description: Forgejo version (or commit reference) of your instance + - type: input + id: runner-ver + attributes: + label: Runner Version + description: Runner version (or commit reference) of the runner on your instance + - type: textarea + id: forgejo-run-info + attributes: + label: How are you running Forgejo? + description: | + Please include information on whether you built Forgejo yourself, used one of our downloads, or are using some other package. + Please also tell us how you are running Forgejo, e.g. if it is being run from a container, a command-line, systemd etc. + If you are using a package or systemd tell us what distribution you are using. + validations: + required: true + - type: textarea + id: runner-run-info + attributes: + label: How are you running the Runner? + description: | + Please include information on whether you built the Runner yourself, used one of our downloads, or are using some other package. + Please also tell us how you are running it, e.g. if it is being run from a container, a command-line, systemd etc. + If you are using a package or systemd tell us what distribution you are using. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs + description: | + It's really important to provide pertinent logs. You must give us `DEBUG` level logs. + Please read https://forgejo.org/docs/latest/admin/logging-documentation/. + + Please copy and paste your logs here, with any sensitive information (e.g. API keys) removed/hidden. + You can wrap your logs in `
...
` tags so it doesn't take up too much space in the issue. + - type: textarea + id: workflow + attributes: + label: Workflow file + description: | + If the bug occurs in a specific workflow, please provide an example workflow file. + If you have linked to a reproduction repository this won't be necessary. diff --git a/.forgejo/issue_template/feature-request.yaml b/.forgejo/issue_template/feature-request.yaml new file mode 100644 index 0000000..3daeafd --- /dev/null +++ b/.forgejo/issue_template/feature-request.yaml @@ -0,0 +1,26 @@ +name: 💡 Feature Request +description: Got an idea for an improvement to the Forgejo Runner? Suggest it here! +title: "feat: " +labels: ["Kind/Enhancement"] +body: +- type: markdown + attributes: + value: | + - Please speak English, as this is the language all maintainers can speak and write. + - Be as clear and concise as possible. A very verbose request is harder to interpret in a concrete way. + - Be civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct). + - Please make sure you are using the latest release of the runner and take a moment to [check that your feature hasn't already been suggested](https://code.forgejo.org/forgejo/runner/issues?q=&type=all). +- type: textarea + id: needs-benefits + attributes: + label: Needs and benefits + description: As concisely as possible, describe the benefits your feature request will provide or the problems it will try to solve. + validations: + required: true +- type: textarea + id: description + attributes: + label: Feature Description + description: As concisely as possible, describe the feature you would like to see added or the changes you would like to see made to Forgejo. + validations: + required: true