2020-11-09 03:59:44 -05:00
## Contributing to AsyncHTTPRequest_Generic
2020-09-13 23:05:46 -04:00
### Reporting Bugs
2020-11-09 03:59:44 -05:00
Please report bugs in [AsyncHTTPRequest_Generic ](https://github.com/khoih-prog/AsyncHTTPRequest_Generic/issues/new ) if you find them.
2020-09-13 23:05:46 -04:00
However, before reporting a bug please check through the following:
2020-11-09 03:59:44 -05:00
* [Existing Open Issues ](https://github.com/khoih-prog/AsyncHTTPRequest_Generic/issues ) - someone might have already encountered this.
2020-09-13 23:05:46 -04:00
2020-11-09 03:59:44 -05:00
If you don't find anything, please [open a new issue ](https://github.com/khoih-prog/AsyncHTTPRequest_Generic/issues/new ).
2020-09-13 23:05:46 -04:00
### How to submit a bug report
Please ensure to specify the following:
2020-11-09 03:59:44 -05:00
* Arduino IDE version (e.g. 1.8.13) or Platform.io version
2021-04-12 00:32:52 -04:00
* `ESP8266` ,`ESP32` or `STM32` Core Version (e.g. ESP8266 core v2.7.4, ESP32 v1.0.6 or STM32 v1.9.0)
2020-09-13 23:05:46 -04:00
* 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
```
2020-11-09 03:59:44 -05:00
Arduino IDE version: 1.8.13
2021-04-12 00:32:52 -04:00
ESP32 Core Version 1.0.6
2020-11-09 03:59:44 -05:00
OS: Ubuntu 20.04 LTS
2021-04-12 00:32:52 -04:00
Linux xy-Inspiron-3593 5.4.0-70-generic #78 -Ubuntu SMP Fri Mar 19 13:29:52 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
2020-09-13 23:05:46 -04:00
Context:
I encountered an endless loop while trying to connect to Local WiFi.
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.
2020-11-09 03:59:44 -05:00
There are usually some outstanding feature requests in the [existing issues list ](https://github.com/khoih-prog/AsyncHTTPRequest_Generic/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement ), feel free to add comments to them.
2020-09-13 23:05:46 -04:00
### Sending Pull Requests
Pull Requests with changes and fixes are also welcome!