CONTRIBUTING.md

Contributing to ESP8266TimerInterrupt

Reporting Bugs

Please report bugs in ESP8266TimerInterrupt Issues if you find them.

However, before reporting a bug please check through the following:

• Existing Open Issues - someone might have already encountered this.

If you don't find anything, please open a new issue.

How to submit a bug report

Please ensure to specify the following:

• Arduino IDE version (e.g. 1.8.19) or Platform.io version
• ESP8266 Core Version (e.g. ESP8266 core v3.0.2)
• 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: v1.8.19
ESP8266 Core Version v3.0.2
ESP8266_NODEMCU
OS: Ubuntu 20.04 LTS
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 a crash while trying to use the library

Steps to reproduce:
1. ...
2. ...
3. ...
4. ...

---

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, 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/ESP8266TimerInterrupt_GitHub/
xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266TimerInterrupt_GitHub$

2. Issue astyle command

xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266TimerInterrupt_GitHub$ bash utils/restyle.sh