Skip to content

Commit 2dca46c

Browse files
authored
Comments in templates (dotnet#1498)
* Comments in templates * Update .github/ISSUE_TEMPLATE/bug_report.md
1 parent 76c7b28 commit 2dca46c

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ assignees: ''
99

1010
**Describe the bug**
1111

12-
A clear and concise description of what the bug is.
12+
<!-- A clear and concise description of what the bug is. -->
1313

1414
**Steps to reproduce**
1515

@@ -19,17 +19,18 @@ A clear and concise description of what the bug is.
1919

2020
**Expected behavior**
2121

22-
Describe what did you expect to happen
22+
<!-- Describe what you expected to happen -->
2323

2424
**Actual behavior**
2525

26-
Describe what actually happened
26+
<!-- Describe what actually happened -->
2727

2828
**Versions used**
2929

30-
Add following information:
30+
<!-- Please add the following information:
3131
3232
- `dotnet --info` on the machine being used to build
3333
- `dotnet --info` on the machine where app is being run (not applicable for self-contained apps)
3434
- Version of `System.Device.Gpio` package
3535
- Version of `Iot.Device.Bindings` package (not needed if bug is in `System.Device.Gpio`)
36+
-->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ assignees: ''
99

1010
**Is your feature request related to a problem? Please describe.**
1111

12-
Describe what problem are you trying to solve or what's the expected outcome.
12+
<!-- Describe what problem are you trying to solve or what's the expected outcome.
1313
1414
If you'd like us to add a new device binding please add a full name and ideally links to specification / pictures of device you'd like to see here.
1515
16-
Please review [list of devices](https://github.com/dotnet/iot/blob/main/src/devices/README.md) to see if there is any similar device (perhaps belonging to the same family) which can be extended to also support your device.
16+
Please review [list of devices](https://github.com/dotnet/iot/blob/main/src/devices/README.md) to see if there is any similar device (perhaps belonging to the same family) which can be extended to also support your device. -->
1717

1818
**Describe the ideal solution**
1919

20-
A clear and concise description of what you want to happen.
20+
<!-- A clear and concise description of what you want to happen. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
<!--
12
- If PR is fixing any issue please add `Fixes #1234` as a first thing in the description of your PR
23
- Describe what is the issue being fixed
34
- If there is any follow-up work please create issues for that
45
- If your PR is adding device binding please make sure to read [conventions for devices APIs](https://github.com/dotnet/iot/blob/main/Documentation/Devices-conventions.md)
56
- Avoid force pushing to your PR (especially on large PRs) - it makes it much harder to incrementally review
7+
-->

0 commit comments

Comments
 (0)