Skip to content

Commit

Permalink
fix(testing.yml): shrink instructions heading and render markdown cor…
Browse files Browse the repository at this point in the history
…rectly

Signed-off-by: L483 <55800398+L483@users.noreply.github.com>
  • Loading branch information
L483 committed Aug 2, 2023
1 parent abd0ee3 commit 5d86b7e
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions .github/ISSUE_TEMPLATE/testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,37 @@ 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 testing request
</b></summary>
Do **not abuse** a *testing* issue to test out new stuff that may or may not be included in the project, like, experimenting with new tools to see whether you can get them to work or whether they are appropriate for the project.
Use a *feature request* or a *feature change request* instead, work on them on their own branch, and (if fitting) mark them with the `Flag: Suggestion` label.
Keep in mind not all *opened* and *accepted* issues have to be resolved. They can also be *abandoned* if the experiments turn out as a fail.
</details>
<details>
<summary><b>
Click here for: How to handle multiple little testing improvement suggestions 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.
However, create a **separate** issue for each issue that is concerned with the *test suite* itself.
</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 @@ -43,7 +49,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 5d86b7e

Please sign in to comment.