Skip to content

Commit 0e9e177

Browse files
committed
Fix #612: add new documentation issue template
1 parent 010bd07 commit 0e9e177

File tree

4 files changed

+37
-6
lines changed

4 files changed

+37
-6
lines changed

.github/ISSUE_TEMPLATE/00-support-request.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,19 @@ assignees: terrillmoore
77

88
---
99

10+
**Consider raising support questions on the forum first**
11+
12+
There is a discussion site, [forum.mcci.io](https://forum.mcci.io), which includes a [category focused on the Arduino LMIC](https://forum.mcci.io/c/device-software/arduino-lmic/5). Unless you're sure that your problem is a bug in the LMIC, it would be great if you can try for help there first. That will keep issues focused on work that needs to be done by the developers.
13+
1014
**Describe your question or issue**
11-
A clear and concise description of the problem you're facing and what you'd like help with.
15+
16+
Please give a clear and concise description of the problem you're facing and what you'd like help with.
1217

1318
**Environment**
1419

15-
This information is all important; it's hard to help without a complete set of answers.
20+
This information is very important; it's hard to help without a complete set of answers.
1621

17-
- Version of LMIC being used:
22+
- Version of LMIC being used. If using the latest github mainline, let us know, otherwise state the version.
1823
- Version of Arduino IDE being used:
1924
- Network provider (The Things Network, Swisscom, ChirpStack, etc.)
2025
- Region (EU868, US915, etc.)

.github/ISSUE_TEMPLATE/bug_report.md renamed to .github/ISSUE_TEMPLATE/10-bug_report.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,32 @@ assignees: terrillmoore
99

1010
**Describe the bug**
1111

12-
A clear and concise description of what the bug is. _If you're not sure it's a bug, please file a Support Request instead._ A bug is a problem in the code, where you do something that the documentation says should work, but doesn't; _and_ you have reason to believe it's not working due to a defect in the code.
12+
A clear and concise description of what the bug is. _If you're not sure it's a bug, please consider opening a discussion at [forum.mcci.io](https://forum.mcci.io/c/device-software/arduino-lmic/5), or file a Support Request instead._ A bug is a problem in the code, where you do something that the documentation says should work, but doesn't; _and_ you have reason to believe it's not working due to a defect in the code.
1313

1414
Wireless is tricky; if in doubt, start with a support request, rather than a bug report.
1515

1616
**Environment**
1717

18-
- Version of LMIC being used:
19-
- Version of Arduino IDE being used:
18+
- Version of LMIC being used. If using the latest GitHub mainline, let us know, otherwise state the version.
19+
- Version of Arduino IDE being used.
2020
- Network provider (The Things Network, Swisscom, ChirpStack, etc.)
2121
- Region (EU868, US915, etc.)
2222
- Board (MCCI Catena, Adafruit Feather M0, Heltec, etc.)
2323
- CPU (AVR, STM32L0, etc.)
2424
- Radio (HopeRF, SX1276, etc.)
2525

2626
**To Reproduce**
27+
2728
Steps to reproduce the problem.
2829

2930
**Expected behavior**
31+
3032
A clear and concise description of what you expected to happen.
3133

3234
**Screenshots**
35+
3336
If applicable, add screenshots to help explain your problem.
3437

3538
**Additional context**
39+
3640
Add any other context about the problem here.
File renamed without changes.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Documentation issue
3+
about: Report a problem in the documentation
4+
title: ''
5+
labels: docs
6+
assignees: terrillmoore
7+
8+
---
9+
10+
Thanks for your contribution!
11+
12+
**What document is involved?**
13+
14+
If this is an existing document, please include the full path to the file.
15+
16+
If there's a need for a new document, please suggest the places in existing docs that should link to it.
17+
18+
Make sure you mention the version, and please also check the current version at GitHub, to be sure that the problem hasn't already been corrected for a pending release.
19+
20+
**What changes are needed?**
21+
22+
Indicate the changes you think are needed. Explicit help is always better. File a PR with your changes if possible!

0 commit comments

Comments
 (0)