From 867665596a282d54cb16e8af4be7b24cb613a059 Mon Sep 17 00:00:00 2001 From: Otto Richter Date: Fri, 19 Dec 2025 09:41:28 +0100 Subject: [PATCH] New issue templates (#10054) Related to https://codeberg.org/forgejo/discussions/issues/415 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10054 Reviewed-by: Mathieu Fenniak Reviewed-by: Michael Kriese Co-authored-by: Otto Richter Co-committed-by: Otto Richter --- .forgejo/issue_template/1-problem.yaml | 86 +++++++++++++++++++ .forgejo/issue_template/2-enhancement.yaml | 30 +++++++ ...ug-report-ui.yaml => 3-bug-report-ui.yaml} | 2 +- .../{bug-report.yaml => 4-bug-report.yaml} | 2 +- .forgejo/issue_template/feature-request.yaml | 31 ------- 5 files changed, 118 insertions(+), 33 deletions(-) create mode 100644 .forgejo/issue_template/1-problem.yaml create mode 100644 .forgejo/issue_template/2-enhancement.yaml rename .forgejo/issue_template/{bug-report-ui.yaml => 3-bug-report-ui.yaml} (95%) rename .forgejo/issue_template/{bug-report.yaml => 4-bug-report.yaml} (97%) delete mode 100644 .forgejo/issue_template/feature-request.yaml diff --git a/.forgejo/issue_template/1-problem.yaml b/.forgejo/issue_template/1-problem.yaml new file mode 100644 index 0000000000..39008de1d2 --- /dev/null +++ b/.forgejo/issue_template/1-problem.yaml @@ -0,0 +1,86 @@ +name: "Step 1: Report a problem or need" +description: Please start here and describe your situation. +title: "problem: " +labels: ["problem", "impact/unknown"] +body: +- type: markdown + attributes: + value: | + **NOTE: If your issue is a security concern, please email ([security.txt](https://forgejo.org/.well-known/security.txt)) 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 civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct). + - Take a moment to [check if a similar problem has already been discussed in the past.](https://codeberg.org/forgejo/forgejo/issues?q=&type=all&labels=78137). Feel free to add your own experience there, if applicable. + - We are currently experimenting with a new workflow to understand your problems and requests. Please try to focus on explaining the problem you are facing, which could be a bug in the code, a moment of confusion, or a missing feature. We'll think about solutions to the problem at a later step. If you want to learn more about the background of our workflow, feel invited to read and participate in [the discussion that led to the current approach](https://codeberg.org/forgejo/discussions/issues/415). We are looking forward to your feedback. +- type: dropdown + id: can-reproduce + attributes: + label: Does your problem still exist on the latest Forgejo version? + description: | + Please try reproducing your problem at https://dev.next.forgejo.org or a local development version of Forgejo. + If you check that your problem is not already addressed by a recent change, this will save all volunteers involved a lot of time. + options: + - "Yes, the problem still exists (tested on a next instance)" + - "Yes, the problem still exists (tested locally with the latest development version)" + - "Unknown, I can't try it for some reason (please explain)" + validations: + required: true +- type: textarea + id: environment + attributes: + label: Your usage of Forgejo + description: | + Please provide a description of your usage of Forgejo. To better understand your problem, it will be relevant to know in which environment you use Forgejo and if you have performed specific configuration. +
Further instructions + + * If you report a bug with a certain functionality, it will be relevant to learn about related configuration ("This is how I configured my identity provider", "This is how my Forgejo Actions runner is set up"). + * Please elaborate on your personal relation to Forgejo and user role ("I'm new to Forgejo, but used a comparable product called …", "In my role as a designer, …"). + * If you feel that Forgejo needs a change in functionality, please describe in which environment you want to use it, so that we can understand for which audience the complexity needs to appeal to ("We're a group of friends with no technical / professional background and use a personal Forgejo instance to prepare our first libre game"). + * If you already explained your usage of Forgejo elsewhere (e.g. in another issue or in a user research repository), you can put a link here. + +
+ validations: + required: true +- type: textarea + id: description + attributes: + label: Problem description + description: | + Please describe your problem as a first-hand experience. Try to focus on the problem. Finding a solution will happen in a next step. +
Further instructions + + * Start by explaining what you want to achieve ("I wanted to find an issue to work on"). + * Try to include steps that you took and that resulted in the current situation. ("I opened the issue tracker, clicked on …, then …"). + * If there were moments of confusion, please describe them. ("There was a button saying … and I was not sure if it would do what I expect"). + * If you want to do something and don't know how or if it is possible, explain the goal ("I would like to know if there are issues that meet the following criteria …"). + +
+ validations: + required: true +- type: textarea + id: workarounds + attributes: + label: Potential workarounds + description: | + If you found a solution to your problem, even if it is not great, please share your experiences with it. +
Further instructions + + * Start by explaining what you tried and how it worked out ("I used X and it gives me the results, but it takes a lot of time to click through the UI"). + * What are the major problems with your workaround(s)? ("It takes long to get there", "It looks very ugly") + +
+- type: input + id: forgejo-ver + attributes: + label: Forgejo Version + description: Forgejo version (or commit reference) your instance is running +- type: textarea + id: versions + attributes: + label: Other details about your environment (software names and versions) + description: | + Please include details to help us understand your problem: browser engine and version (for UI issues), operating system and version running Forgejo, database engine and version, deployment methods and relevant third-party packages (e.g. renderers, identity providers) + validations: + required: true diff --git a/.forgejo/issue_template/2-enhancement.yaml b/.forgejo/issue_template/2-enhancement.yaml new file mode 100644 index 0000000000..3014d8901a --- /dev/null +++ b/.forgejo/issue_template/2-enhancement.yaml @@ -0,0 +1,30 @@ +name: "Step 2: Enhancement" +description: Suggest a solution to one or multiple problems that have already been reported (see step 1). +title: "enh: " +labels: ["enhancement/feature"] +body: +- type: markdown + attributes: + value: | + - Please speak English, as this is the language all maintainers can speak and write. + - Be civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct). + - We are currently experimenting with a new workflow to understand your problems and requests. This is step 2 of a two-step-process. The goal is to discuss potential solutions to already-reported problems. If you want to learn more about the background of our workflow, feel invited to read and participate in [the discussion that led to the current approach](https://codeberg.org/forgejo/discussions/issues/415). We are looking forward to your feedback. +- type: textarea + id: problems + attributes: + label: Existing problems this enhancement addresses + description: List the issue numbers of the reported problems that this enhancement addresses. If you haven't previously described a problem, please [complete step one of the workflow](https://codeberg.org/forgejo/forgejo/issues/new?template=.forgejo%2fissue_template%2fproblem.yaml) and describe the problem you'd like to solve first. + validations: + required: true +- type: textarea + id: description + attributes: + label: Enhancement description + description: As concisely as possible, describe the changes you suggest for Forgejo and explain how they address the problems. + validations: + required: true +- type: textarea + id: details + attributes: + label: Details and notes + description: Feel free to supply additional information like technical considerations, link to alternative solutions, UI mockups etc. diff --git a/.forgejo/issue_template/bug-report-ui.yaml b/.forgejo/issue_template/3-bug-report-ui.yaml similarity index 95% rename from .forgejo/issue_template/bug-report-ui.yaml rename to .forgejo/issue_template/3-bug-report-ui.yaml index 1c66c3b648..4a70dbc8ba 100644 --- a/.forgejo/issue_template/bug-report-ui.yaml +++ b/.forgejo/issue_template/3-bug-report-ui.yaml @@ -1,5 +1,5 @@ name: 🦋 Bug Report (web interface / frontend) -description: Something doesn't look quite as it should? Report it here! +description: "[Advanced users only] Something doesn't look quite as it should? Report it here!" title: "bug: " labels: ["bug/new-report", "forgejo/ui"] body: diff --git a/.forgejo/issue_template/bug-report.yaml b/.forgejo/issue_template/4-bug-report.yaml similarity index 97% rename from .forgejo/issue_template/bug-report.yaml rename to .forgejo/issue_template/4-bug-report.yaml index c11ebf9c1f..93419ae067 100644 --- a/.forgejo/issue_template/bug-report.yaml +++ b/.forgejo/issue_template/4-bug-report.yaml @@ -1,5 +1,5 @@ name: 🐛 Bug Report (server / backend) -description: Found something you weren't expecting? Report it here! +description: "[Advanced users only] Found something you weren't expecting? Report it here!" title: "bug: " labels: bug/new-report body: diff --git a/.forgejo/issue_template/feature-request.yaml b/.forgejo/issue_template/feature-request.yaml deleted file mode 100644 index 0996680cb4..0000000000 --- a/.forgejo/issue_template/feature-request.yaml +++ /dev/null @@ -1,31 +0,0 @@ -name: 💡 Feature Request -description: Got an idea for a feature that Forgejo doesn't have yet? Suggest it here! -title: "feat: " -labels: ["enhancement/feature"] -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 Forgejo and take a moment to [check that your feature hasn't already been suggested](https://codeberg.org/forgejo/forgejo/issues?q=&type=all&labels=78139). -- 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 -- type: textarea - id: screenshots - attributes: - label: Screenshots - description: If you can, provide screenshots of an implementation on another site, e.g. GitHub.