Skip to content

Commit 6d0c9bf

Browse files
authored
Merge pull request #253 from CCPBioSim/251-docs-improve-readability-of-github-issues
Update GitHub Issues to Include HTML Friendly Comments
2 parents 832d0f7 + 7e38a20 commit 6d0c9bf

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ assignees: ''
88
---
99

1010
# Bug Report
11-
12-
**Describe the bug**
1311
<!-- A clear and concise description of the issue. -->
1412

1513
---
@@ -63,10 +61,10 @@ Remove unrelated fields to make it minimal. -->
6361

6462
## Screenshots or Logs
6563

66-
Attach any relevant screenshots, logs, or stack traces.
64+
<!-- Attach any relevant screenshots, logs, or stack traces. -->
6765

6866
---
6967

7068
## Additional Context
7169

72-
Include anything else that might help reproduce or understand the bug, such as changes from a previously working version.
70+
<!-- Include anything else that might help reproduce or understand the bug, such as changes from a previously working version. -->

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ assignees: ''
77
---
88

99
### Documentation Update
10-
What part of the documentation needs to be updated or added?
10+
<!-- What part of the documentation needs to be updated or added? -->
1111

1212
### Why Is This Needed?
13-
Explain the importance of this update.
13+
<!-- Explain the importance of this update. -->
1414

1515
### Suggested Changes
16-
Provide a detailed description of the changes.
16+
<!-- Provide a detailed description of the changes. -->
1717

1818
### Additional Context
19-
Include any related resources.
19+
<!-- Include any related resources. -->

.github/ISSUE_TEMPLATE/general_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ assignees: ''
77
---
88

99
### Feedback or Inquiry
10-
Provide your feedback or inquiry.
10+
<!-- Provide your feedback or inquiry. -->
1111

1212
### Additional Information
13-
Add any other relevant details here.
13+
<!-- Add any other relevant details here. -->

0 commit comments

Comments
 (0)