Skip to content

Commit

Permalink
issue template: put instructions in comments
Browse files Browse the repository at this point in the history
People don't always think to remove the instructions when filing an issue. Putting them
in markdown comment blocks at least prevents
them from visually polluting the resulting issue.
  • Loading branch information
jonathanperret authored and dl1com committed Sep 15, 2024
1 parent bff8dbe commit 79fc553
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Knitting machine:
AYAB hardware:

**Describe the bug**
A clear and concise description of what the bug is.
<!-- A clear and concise description of what the bug is. -->

**To Reproduce**
Steps to reproduce the behavior:
Expand All @@ -24,10 +24,10 @@ Steps to reproduce the behavior:
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
<!-- A clear and concise description of what you expected to happen. -->

**Screenshots**
If applicable, add screenshots to help explain your problem.
<!-- If applicable, add screenshots to help explain your problem. -->

**Additional context**
Add any other context about the problem here.
<!-- Add any other context about the problem here. -->

0 comments on commit 79fc553

Please sign in to comment.