From 0accdded17b3b365aef8df0e83a7a25a17cf292a Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Tue, 16 Jul 2024 14:33:21 +0200 Subject: [PATCH 1/2] docs(issues): encourage the use of conventional commits It is not enforced but it is widely spread and encouraging its use may lead to more uniform issue titles overall. https://www.conventionalcommits.org/en/v1.0.0/ --- .gitea/issue_template/bug-report-ui.yaml | 2 +- .gitea/issue_template/bug-report.yaml | 2 +- .gitea/issue_template/feature-request.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.gitea/issue_template/bug-report-ui.yaml b/.gitea/issue_template/bug-report-ui.yaml index 09513d08e7..8cfe5568cf 100644 --- a/.gitea/issue_template/bug-report-ui.yaml +++ b/.gitea/issue_template/bug-report-ui.yaml @@ -1,6 +1,6 @@ name: 🦋 Bug Report (web interface / frontend) description: Something doesn't look quite as it should? Report it here! -title: "[BUG] " +title: "bug: " labels: ["bug/new-report", "forgejo/ui"] body: - type: markdown diff --git a/.gitea/issue_template/bug-report.yaml b/.gitea/issue_template/bug-report.yaml index 3c9b74bd5b..6e9b116e60 100644 --- a/.gitea/issue_template/bug-report.yaml +++ b/.gitea/issue_template/bug-report.yaml @@ -1,6 +1,6 @@ name: 🐛 Bug Report (server / backend) description: Found something you weren't expecting? Report it here! -title: "[BUG] " +title: "bug: " labels: bug/new-report body: - type: markdown diff --git a/.gitea/issue_template/feature-request.yaml b/.gitea/issue_template/feature-request.yaml index 4b10bea145..0996680cb4 100644 --- a/.gitea/issue_template/feature-request.yaml +++ b/.gitea/issue_template/feature-request.yaml @@ -1,6 +1,6 @@ name: 💡 Feature Request description: Got an idea for a feature that Forgejo doesn't have yet? Suggest it here! -title: "[FEAT] " +title: "feat: " labels: ["enhancement/feature"] body: - type: markdown From fa263edcc372f590235eb8691d04505d50d39209 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Tue, 16 Jul 2024 14:39:23 +0200 Subject: [PATCH 2/2] docs: rework the user interface 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: os-ver` as it has never been relevant. * do not require `id: forgejo-ver` because it does not matter that much as long as it can be reproduced on try.next. * remove "If the error appears to relate to Forgejo the server" as it has never been relevant. * require the description --- .gitea/issue_template/bug-report-ui.yaml | 42 ++++++++++-------------- 1 file changed, 18 insertions(+), 24 deletions(-) diff --git a/.gitea/issue_template/bug-report-ui.yaml b/.gitea/issue_template/bug-report-ui.yaml index 8cfe5568cf..57d578b232 100644 --- a/.gitea/issue_template/bug-report-ui.yaml +++ b/.gitea/issue_template/bug-report-ui.yaml @@ -13,16 +13,29 @@ 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). - If you think this is a JavaScript error, show us the JavaScript console. - If the error appears to relate to Forgejo the server, please also give us `DEBUG` level logs. (See https://forgejo.org/docs/latest/admin/logging-documentation/) + Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see above). + If you think this is a JavaScript error, include a copy of the JavaScript console. + validations: + required: true - type: textarea id: screenshots attributes: @@ -35,20 +48,6 @@ body: attributes: label: Forgejo Version description: Forgejo version (or commit reference) your instance is running - validations: - required: true -- type: dropdown - id: can-reproduce - attributes: - label: Can you reproduce the bug on Forgejo Next? - 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" - validations: - required: true - type: input id: browser-ver attributes: @@ -56,8 +55,3 @@ body: description: The browser and version that you are using to access Forgejo validations: required: true -- type: input - id: os-ver - attributes: - label: Operating System - description: The operating system you are using to access Forgejo