Skip to content

Commit

Permalink
fix(text-correction.yml): shrink instructions heading and render mark…
Browse files Browse the repository at this point in the history
…down correctly

Signed-off-by: L483 <55800398+L483@users.noreply.github.com>
  • Loading branch information
L483 committed Aug 2, 2023
1 parent 5d86b7e commit 676d93f
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions .github/ISSUE_TEMPLATE/text-correction.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,36 @@ body:
- type: markdown
attributes:
value: |
# How to use this issue form
### How to use this issue form
<details>
<summary><b>
Click here for: What not to do when creating a text-correction request
</b></summary>
Do **not** abuse a *text correction* issue to refactor the code itself, like renaming a variable or class.
Do **not** abuse a *text correction* issue to fix a bug caused by, for example, a typo, and use a *bug report* instead.
Use it **only** for corrections of string contents, documentation parts, code comments, and any text that will be displayed to users.
</details>
<summary><b>
<details>
<summary><b>
Click here for: How to handle multiple little text-corrections in a single issue
</b></summary>
If there are *multiple little improvement suggestions*, you can mention them bundled within a *single issue* because the effort of writing issues should not drastically surpass the effort of resolving them.<br/>
Make sure to present each improvement **distinctly** from the rest and to use the **same order** of refinements in each section when bundling multiple improvements inside one issue.
</details>
All text areas support markdown syntax unless explicitly noted otherwise.
<details>
<summary><b>
Click here for: Information for contributors about label usage
</b></summary>
</b></summary>
- select *any number* of fitting labels that have a `Flag: ` prefix
- select *any number* of fitting labels that have a `For: ` prefix
- select **exactly one** label that has a `Priority: ` prefix
Expand All @@ -41,7 +48,9 @@ body:
Look at the label descriptions to grasp their proper usage and pick the most fitting.
If more than one `Type: ` label fits the issue, it is a good indicator that the issue mixes concerns.
You should then split this issue into multiple issues so that each new issue falls **exactly into one** category.
</details>
---
- type: textarea
id: object-of-interest
Expand Down

0 comments on commit 676d93f

Please sign in to comment.