upstream/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2026-05-28 11:14:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Heavily trim and rework text

Browse source 
The previous templates had a lot of text, and it is unlikely that users read it.
Cut it down as much as possible, and clearly explaind and emphasize the important parts.
This commit is contained in:
Otto Richter 2026-04-05 23:12:23 +02:00 committed by Otto Richter
parent 92e7a88d6a
commit 9cf22117e7
5 changed files with 99 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
.forgejo/issue_template/1-triaging.yaml
View file

@ -1,5 +1,5 @@
name: "Stage 1: Report a problem or need"
description: "[Start here] Describe a problem or need"
description: "[➡️ Start here] Describe your experience using Forgejo, including things that are not working or need a feature"
labels: ["stage/1-triaging", "impact/unknown", "affects/unknown"]
body:
- type: markdown
@ -9,29 +9,35 @@ body:
- type: markdown
attributes:
value: |
- Please speak English, as this is the language all maintainers can speak and write.
- Please write in English.
- Be civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct).
- If you intend to use AI for communication in this issue, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- Take a moment to [check if a similar situation 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.
- If you are using AI for communication, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md).\
tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- Please [check for similar described problems](https://codeberg.org/forgejo/forgejo/issues?q=&type=all&labels=78137). Feel free to **add a comment with your own experience** there.
- type: markdown
attributes:
value: |
### New workflow
We are currently experimenting with a new workflow to manage issues and better understand your problems and needs. 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 are introducing **a new workflow** to manage issues and understand your problems and needs.
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.
<details><summary>**Instructions for your first problem report**</summary>
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.
* Focus on **your problem**.
* Take some time to describe your situation.
* **Do not suggest a solution** in the form.
* We want to remain open-minded. There are usually multiple ways to address an issue. We aim to consider carefully, avoiding too early bias.
* You are **not required** to follow-up with a solution. You can just drop your problem report and leave the rest to us.
* However, if you want to share your idea, it is fine to follow up with it in a common in the conversation, outside of this template.
* Want to learn more? [→ Workflow documentation](), [→ Discussion issue](https://codeberg.org/forgejo/discussions/issues/415).
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.
</details>
- 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.
Please help all of us save time by **checking that your problem still exists** at https://dev.next.forgejo.org or a local development version of Forgejo.
options:
- "Yes, the problem still exists (tested on a next instance)"
- "Yes, the problem still exists (tested locally with the latest development version)"
@ -43,14 +49,15 @@ body:
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>More details</summary>
A (brief) description of your Forgejo usage. You can be brief, but we value the insights you share. It helps us to understand your use case.
* 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.
* 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.
<details><summary>Details</summary>
* Already explained your usage elsewhere? Link to the issue or other data sources.
* Include related information to your problem. Examples:
* You describe confusion: Include your background and skills ("New, but used a similar product", "In my role as a project manager ..."). It allows to match the design to the target audience.
* An issue with instance configuration / sign-up / identity providers etc: Clarify if you use Forgejo in a 10-users non-profit / start up, or rather in a larger project / university / enterprise.
* Project workflows / repo and user settings: How large is your project? How many team members? Which roles do you have in your project?
</details>
validations:
@ -60,13 +67,15 @@ body:
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>More details</summary>
Please focus on **your first-hand experience** and the problem or need you encountered. **Do not suggest a solution!**
* Start by explaining what you want to achieve ("I wanted to find an issue to work on", "I want to manage the permissions for my project").
* 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><summary>Details</summary>
* What you want to achieve? ("I wanted to find an issue to work on", "I want to manage the permissions for my project")
* Which steps did you take? ("I opened the issue tracker, clicked on …, then …")
* Did you get confused at any step? Please explain. ("There was a button saying … and I was not sure if it would do what I expect")
* What is your goal? ("I would like to know if there are issues that meet the following criteria …")
* Feel free to include a few screenshots or short video demonstrations.
</details>
validations:
@ -74,26 +83,32 @@ body:
- type: textarea
id: workarounds
attributes:
label: Potential workarounds
label: Workarounds
description: |
If you found a solution to your problem, even if it is not great, please share your experiences with it.
<details><summary>More details</summary>
Found a (temporary / bad) solution for your problem? Please share your experiences with it.
* 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><summary>Details</summary>
* What did you try? How well did it work? ("I used X and it gives me almost what I want ...").
* What are the 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.
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)
Please include as much as possible. You can remove the parts of the template that are not relevant to your situation.
value: |
* Operating system and version running Forgejo:
* Database engine and version:
* Deployment methods and relevant third-party packages (e.g. renderers, identity providers):
* [For UI issues] Browser engine and version:
validations:
required: true
- type: markdown

30
.forgejo/issue_template/2-research.yaml
View file

@ -1,29 +1,39 @@
name: "Step 2: Research"
description: "[Contributors only] Create research / collection about related problems"
name: "Stage 2: Research"
description: "[Contributors only] Create research task / collection about related problems"
labels: ["stage/2-research"]
body:
- type: markdown
attributes:
value: |
- Please speak English, as this is the language all maintainers can speak and write.
- Please write in English.
- Be civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct).
- If you intend to use AI for communication in this issue, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- If you are using AI for communication, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md).\
tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- 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 2 of the workflow, which is intended for Forgejo contributors. If you just want to raise a problem or need you have, please refer to step 1.
We are introducing **a new workflow** to manage issues and understand your problems and needs.
Want to report a bug or request a feature? Please follow step 1 instead.
This step is intended to focus on researching the problems users are facing when a single issue is not enough for this (e.g. a lot of related problem reports that need to be discussed and summarized, or external sources such as user testing, surveys etc that need to be included).
<details><summary>**Instructions for research tasks**</summary>
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.
* Why should this be researched (motivation)?
* What questions should be answered? What information is missing?
* What existing information is available? (user problems and other data)
* Who is interested in working on ...
* This research? (If no one, the user research team will consider to take over)
* The next steps?
* Want to learn more? [→ Workflow documentation](), [→ Discussion issue](https://codeberg.org/forgejo/discussions/issues/415).
</details>
- type: textarea
id: description
attributes:
label: Research description
label: Research task
description: What is the scope of this research issue?
- type: textarea
id: problems
id: information
attributes:
label: Existing problems or data sources
label: Existing information, user reports and other data

21
.forgejo/issue_template/3-design.yaml
View file

@ -1,23 +1,32 @@
name: "Step 3: Design"
name: "Stage 3: Design"
description: "[Contributors only] Create UX/UI or technical design unit"
labels: ["stage/3-design"]
body:
- type: markdown
attributes:
value: |
- Please speak English, as this is the language all maintainers can speak and write.
- Please write in English.
- Be civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct).
- If you intend to use AI for communication in this issue, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- If you are using AI for communication, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md).\
tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- 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 3 of the workflow, which is intended for Forgejo contributors. If you just want to raise a problem or need you have, please refer to step 1.
We are introducing **a new workflow** to manage issues and understand your problems and needs.
Want to report a bug or request a feature? Please follow step 1 instead.
This step is intended to focus on talking about the design of a solution. It covers all relevant aspects, from technical architecture to UI/UX design.
<details><summary>**Instructions for design units**</summary>
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.
* What ideas have already been loosely agreed on?
* What needs to be discussed and clarified ...
* ... in the scope of interaction design / UX?
* ... in the scope of visual / UI design?
* ... in the scope of technical / architectural design?
* Want to learn more? [→ Workflow documentation](), [→ Discussion issue](https://codeberg.org/forgejo/discussions/issues/415).
</details>
- type: textarea
id: description
attributes:

25
.forgejo/issue_template/4-implementation.yaml
View file

@ -1,27 +1,34 @@
name: "Step 4: Implementation"
name: "Stage 4: Implementation"
description: "[Contributors only] Document a task ready for implementation"
labels: ["stage/4-implementation"]
body:
- type: markdown
attributes:
value: |
- Please speak English, as this is the language all maintainers can speak and write.
- Please write in English.
- Be civil, and follow the [Forgejo Code of Conduct](https://codeberg.org/forgejo/code-of-conduct).
- If you intend to use AI for communication in this issue, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- If you are using AI for communication, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md).\
tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- 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 4 of the workflow, which is intended for Forgejo contributors. If you just want to raise a problem or need you have, please refer to step 1.
We are introducing **a new workflow** to manage issues and understand your problems and needs.
Want to report a bug or request a feature? Please follow step 1 instead.
This step is intended to document a task that is actionable to developers and ready for implementation. It is either trivial (e.g. fixing a bug) or has followed the process and was generally accepted as a solution. In particular, this means:
<details><summary>**Instructions for implementation tasks**</summary>
* The problems this change fixes have been described and verified.
* Potential solutions to the problem have been considered and this one was chosen.
* The written details of this issue have been agreed on.
* This task must be actionable to developers, without anticipating further UX design discussion.
* It is either trivial (e.g. fixing a bug) ...
* Or has followed through the previous steps of the process.
* Is all of this true?
* The problem(s) this change fixes have been described and verified.
* Potential solutions to the problem have been considered and this one was chosen.
* The written details of this task have been agreed on. Details can be left open if you don't suggest they are "decided" in this task.
* Want to learn more? [→ Workflow documentation](), [→ Discussion issue](https://codeberg.org/forgejo/discussions/issues/415).
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.
</details>
- type: textarea
id: description
attributes:

5
.forgejo/issue_template/5-bug-report.yaml
View file

@ -25,11 +25,12 @@ body:
- type: markdown
attributes:
value: |
- Please speak English, as this is the language all maintainers can speak and write.
- Please write in English.
- 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://codeberg.org/forgejo/forgejo/issues?q=&type=all&labels=78137).
- If you intend to use AI for communication in this issue, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- If you are using AI for communication, please take a look at Forgejo's AI agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md).\
tl;dr: **Do not use AI to write issues** (excluded for help with translation or language checking)
- type: dropdown
id: can-reproduce
attributes: