mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-12 22:10:25 +00:00
7894e1bb8f
* Separate documentation about the workflow for better attention. I could imagine that it was not read by everyone, since it was after the trivial 'Please write in English' instructions. * Improve explanations about the workflow, expectations and next steps. * Explicitly mark the Enhancement template to be mostly for contributors. * Disable blank issues. I could not really identify any recent usage of it that was legitimate. * Improve instructions about which details to share about the own Forgejo usage. * Explicitly state in the enhancement template that only issue references should go in there, not noise. * Create a placeholder in problem template to add references to potential solutions later. I hope this resolves some of the issues observed with the new workflow and improves the quality of submitted reports. Also addresses the feedback already received in https://codeberg.org/forgejo/user-research/issues/71 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10847 Reviewed-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: Otto Richter <otto@codeberg.org> Co-committed-by: Otto Richter <otto@codeberg.org>
107 lines
6.6 KiB
YAML
107 lines
6.6 KiB
YAML
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@forgejo.org> ([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.
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
### New workflow
|
|
|
|
We are currently experimenting with a new workflow to manage issues and better understand your problems and needs. This is step 1 of the workflow: 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 need that you have.
|
|
|
|
We do not expect anything from Forgejo users after creating a problem report, but we appreciate if you stay responsive to further questions. If you want, you can also participate in a discussion for solutions.
|
|
|
|
Forgejo contributors will review your report, try to understand how important it is to you and other Forgejo users, and suggest potential solutions. In a next step, solutions can be documented and implemented.
|
|
|
|
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: About your usage of Forgejo
|
|
description: |
|
|
Please provide a brief description of your usage of Forgejo. There is no clear guideline on how much you need to share here. You can be brief, but we value the insights you provide us to better understand your use case. Thank you very much!
|
|
<details><summary>Further instructions</summary>
|
|
|
|
* When reporting problems with certain functionality, you should include related information. Examples:
|
|
* When reporting an issue with setting up an identity provider, it is useful to know if you use Forgejo in a 10-users non-profit / start up, or if you are talking about a school / university with several thousands of users.
|
|
* When describing confusion, it will be relevant to know your skill level and background ("New, but used a similar product", "In my role as a project manager ..."), so we know for which target audience we need to design the functionality.
|
|
* When reporting workflow issues or needs, it will be useful to know how large your project is, how many team members you have, which skill level we are talking about etc. For example, we might choose a different design depending on whether a feature is only for professional developers or for hobby coders.
|
|
* If you want, we always appreciate generic information about your Forgejo usage to help us understand your usage and make better decisions. For example:
|
|
* 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 already explained your usage of Forgejo elsewhere (e.g. in another issue or in a user research repository), feel free to just drop a link.
|
|
|
|
</details>
|
|
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. You do not have to find a solution, you can leave this to us.
|
|
<details><summary>Further instructions</summary>
|
|
|
|
* 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 …").
|
|
|
|
</details>
|
|
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.
|
|
<details><summary>Further instructions</summary>
|
|
|
|
* 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")
|
|
|
|
</details>
|
|
- type: input
|
|
id: forgejo-ver
|
|
attributes:
|
|
label: Forgejo Version
|
|
description: Forgejo version (or commit reference) your instance is running or that you used to reproduce the bug on Forgejo Next.
|
|
- 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
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
### Solutions
|
|
|
|
*Accepted solutions to address this problem will go here*
|
|
visible: [content]
|