From 38e91fc76f6f42cbcfb91fed6d37a3780e0047b3 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Mon, 15 Jul 2024 15:49:44 +0200 Subject: [PATCH] docs: rework the bug report template * move `id: can-reproduce` to first position to give incentivize reproducers. If the description comes first, the person filing the bug report will describe the problem in plain English. It is better if the first thing they do, if at all possible, is to create a reproducer and provide a link. * remove `id: screenshots` as they can be copy/pasted to the description when relevant. They are more important int the UI bug report template but not so much here. * remove `id: git-ver` as it is almost never relevant. If it is, this can be included in the description but clutters the template most of the time. * remove `id: os-ver` as it is redundant with what `id: run-info` requires. * dev.next.forgejo.org is running the latest development branch * link to dev.next.forgejo.org instead of next.forgejo.org --- .gitea/issue_template/bug-report.yaml | 59 ++++++++++----------------- 1 file changed, 21 insertions(+), 38 deletions(-) diff --git a/.gitea/issue_template/bug-report.yaml b/.gitea/issue_template/bug-report.yaml index 6fab61fcdc..3c9b74bd5b 100644 --- a/.gitea/issue_template/bug-report.yaml +++ b/.gitea/issue_template/bug-report.yaml @@ -13,14 +13,26 @@ body: - 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). - - Please make sure you are using the latest release of Forgejo and take a moment to [check that your issue hasn't been reported before](https://codeberg.org/forgejo/forgejo/issues?q=&type=all&labels=78137). - - Please give all relevant information below for bug reports, as incomplete details may result in the issue not being considered. + - Take a moment to [check that your issue hasn't been reported before](https://codeberg.org/forgejo/forgejo/issues?q=&type=all&labels=78137). +- 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 below). + 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 @@ -28,18 +40,14 @@ body: attributes: label: Forgejo Version description: Forgejo version (or commit reference) of your instance - validations: - required: true -- type: dropdown - id: can-reproduce +- type: textarea + id: run-info attributes: - label: Can you reproduce the bug on Forgejo Next? + label: How are you running Forgejo? description: | - Please try reproducing your issue at [Forgejo Next](https://next.forgejo.org). - If you can reproduce it, please provide a URL in the Description field. - options: - - "Yes" - - "No" + 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 @@ -53,31 +61,6 @@ body: 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: screenshots - attributes: - label: Screenshots - description: If this issue involves the Web Interface, please provide one or more screenshots -- type: input - id: git-ver - attributes: - label: Git Version - description: The version of git running on the server -- type: input - id: os-ver - attributes: - label: Operating System - description: The operating system you are using to run Forgejo -- type: textarea - id: 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 docker, a command-line, systemd etc. - If you are using a package or systemd tell us what distribution you are using. - validations: - required: true - type: dropdown id: database attributes: