From d3233ff585eb9ca106586fe1094fa2ccfd65a2bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Grome=C5=A1?= Date: Fri, 10 Jul 2020 06:57:46 +0200 Subject: [PATCH] Added module not working issue template --- .github/ISSUE_TEMPLATE/module-not-working.md | 34 ++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/module-not-working.md diff --git a/.github/ISSUE_TEMPLATE/module-not-working.md b/.github/ISSUE_TEMPLATE/module-not-working.md new file mode 100644 index 00000000..1b67e8d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/module-not-working.md @@ -0,0 +1,34 @@ +--- +name: Module not working +about: Template to use when your module isn't working +title: '' +labels: '' +assignees: '' + +--- + +**IMPORTANT: Before submitting an issue, please check the following:** +1. **Read [CONTRIBUTING.md](https://github.com/jgromes/RadioLib/blob/master/CONTRIBUTING.md)!** Issues that do not follow this document will be closed/locked/deleted/ignored. +2. RadioLib has a [Wiki](https://github.com/jgromes/RadioLib/wiki) and an extensive [API documentation](https://jgromes.github.io/RadioLib/). You might find a solution to your issue there. +3. Make sure you're using the latest release of the library! Releases can be found [here](https://github.com/jgromes/RadioLib/releases). +4. Use [Arduino forums](https://forum.arduino.cc/) to ask generic questions about wireless modules, wiring, usage, etc. Only create issues for problems specific to RadioLib! +5. Error codes, their meaning and how to fix them can be found on [this page](https://jgromes.github.io/RadioLib/group__status__codes.html). + +**Sketch that is causing the module fail** + +```c++ +paste the sketch here, even if it is an unmodified example code +``` + +**Hardware setup** +Wiring diagram, schematic, pictures etc. + +**Debug mode output** +Enable all [debug levels](https://github.com/jgromes/RadioLib/wiki/Debug-mode) and paste the Serial monitor output here. + +**Additional info (please complete):** + - MCU: [e.g. Arduino Uno, ESP8266 etc.] + - Link to Arduino core: [e.g. https://github.com/stm32duino/Arduino_Core_STM32 when using official STM32 core. See readme for links to all supported cores] + - Wireless module type [e.g. CC1101, SX1268, etc.] + - Arduino IDE version [e.g. 1.8.5] + - Library version [e.g. 3.0.0]