54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
## Contributing to ESP8266TimerInterrupt
|
|
|
|
### Reporting Bugs
|
|
|
|
Please report bugs in [ESP8266TimerInterrupt Issues](https://github.com/khoih-prog/ESP8266TimerInterrupt/issues) if you find them.
|
|
|
|
However, before reporting a bug please check through the following:
|
|
|
|
* [Existing Open Issues](https://github.com/khoih-prog/ESP8266TimerInterrupt/issues) - someone might have already encountered this.
|
|
|
|
If you don't find anything, please [open a new issue](https://github.com/khoih-prog/ESP8266TimerInterrupt/issues/new).
|
|
|
|
### 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.13.0-35-generic #40~20.04.1-Ubuntu SMP Mon Mar 7 09:18:32 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
|
|
|
|
Context:
|
|
I encountered a crash while trying to use the Timer Interrupt.
|
|
|
|
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](https://github.com/khoih-prog/ESP8266TimerInterrupt/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!
|
|
|