From 55ad4b569ca93836ed586e23ad7f1706708f0ebe Mon Sep 17 00:00:00 2001 From: Khoi Hoang <57012152+khoih-prog@users.noreply.github.com> Date: Wed, 26 Oct 2022 16:50:50 -0400 Subject: [PATCH] Update `.github` --- .github/ISSUE_TEMPLATE/bug_report.md | 46 ++++++++++++++++++++++------ 1 file changed, 37 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ed2f81c..3a722af 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -35,24 +35,26 @@ If applicable, add screenshots to help explain your problem. Please ensure to specify the following: -* Arduino IDE version (e.g. 1.8.13) or Platform.io version -* `ESP8266`,`ESP32` or `STM32` Core Version (e.g. ESP8266 core v2.7.4, ESP32 v1.0.5 or STM32 v1.9.0) +* Arduino IDE version (e.g. 1.8.19) or Platform.io version +* `NRF52` Core Version (e.g. Adafruit NRF52 core v1.3.0, Seeed nRF52 core v1.0.0) * Contextual information (e.g. what you were trying to achieve) * Simplest possible steps to reproduce * Anything that might be relevant in your opinion, such as: * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a` * Network configuration - + + ### Example ``` -Arduino IDE version: 1.8.13 -ESP32 Core Version 1.0.5 +Arduino IDE version: 1.8.19 +Adafruit NRF52 Core Version 1.3.0 +NRF52840_ITSYBITSY OS: Ubuntu 20.04 LTS -Linux xy-Inspiron-3593 5.4.0-66-generic #74-Ubuntu SMP Wed Jan 27 22:54:38 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux +Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux Context: -I encountered an endless loop while trying to connect to Local WiFi. +I encountered a crash while using this library Steps to reproduce: 1. ... @@ -61,6 +63,32 @@ Steps to reproduce: 4. ... ``` -### Additional context +--- + +### Sending Feature Requests + +Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful. + +There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/NRF52_ISR_Servo/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them. + +--- + +### Sending Pull Requests + +Pull Requests with changes and fixes are also welcome! + +Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux) + +1. Change directory to the library GitHub + +``` +xy@xy-Inspiron-3593:~$ cd Arduino/xy/NRF52_ISR_Servo_GitHub/ +xy@xy-Inspiron-3593:~/Arduino/xy/NRF52_ISR_Servo_GitHub$ +``` + +2. Issue astyle command + +``` +xy@xy-Inspiron-3593:~/Arduino/xy/NRF52_ISR_Servo_GitHub$ bash utils/restyle.sh +``` -Add any other context about the problem here.