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:
2021-12-30 16:40:14 -05:00
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
2022-10-18 22:36:53 -04:00
* `ESP8266` ,`ESP32` or `STM32` Core Version (e.g. ESP8266 core v3.0.2, ESP32 v2.0.5 or STM32 v2.3.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
```
2021-12-30 16:40:14 -05:00
Arduino IDE version: 1.8.19
2022-10-18 22:36:53 -04:00
ESP32 Core Version 2.0.5
2020-11-09 03:59:44 -05:00
OS: Ubuntu 20.04 LTS
2022-11-23 17:06:13 -05:00
Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
2020-09-13 23:05:46 -04:00
Context:
2022-11-09 23:46:36 -05:00
I encountered a crash while using this library
2020-09-13 23:05:46 -04:00
Steps to reproduce:
1. ...
2. ...
3. ...
4. ...
```
2021-07-10 00:19:34 -04:00
2022-11-09 23:46:36 -05:00
### Additional context
Add any other context about the problem here.
---
2020-09-13 23:05:46 -04:00
### 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
2022-11-09 23:46:36 -05:00
---
2020-09-13 23:05:46 -04:00
### Sending Pull Requests
Pull Requests with changes and fixes are also welcome!
2022-02-25 20:45:58 -05:00
2022-11-09 23:46:36 -05:00
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/AsyncHTTPRequest_Generic_GitHub/
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncHTTPRequest_Generic_GitHub$
```
2. Issue astyle command
```
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncHTTPRequest_Generic_GitHub$ bash utils/restyle.sh
```
