61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
## Contributing to RPAsyncTCP
|
|
|
|
### Reporting Bugs
|
|
|
|
Please report bugs in [RPAsyncTCP Issues](https://github.com/ayushsharma82/RPAsyncTCP/issues) if you find them.
|
|
|
|
However, before reporting a bug please check through the following:
|
|
|
|
* [Existing Open Issues](https://github.com/ayushsharma82/RPAsyncTCP/issues) - someone might have already encountered this.
|
|
|
|
If you don't find anything, please [open a new issue](https://github.com/ayushsharma82/RPAsyncTCP/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
|
|
* `RP2040` Core Version (e.g. RP2040 core v2.7.1)
|
|
* `RP2040` Board type (e.g. RASPBERRY_PI_PICO_W)
|
|
* 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
|
|
|
|
|
|
Please be educated, civilized and constructive as you've always been. Disrespective posts against [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-event-code-of-conduct) will be ignored and deleted.
|
|
|
|
---
|
|
|
|
### Example
|
|
|
|
```
|
|
Arduino IDE version: 1.8.19
|
|
RP2040 core v2.7.1
|
|
RASPBERRY_PI_PICO_W Module
|
|
OS: Ubuntu 20.04 LTS
|
|
Linux xy-Inspiron-3593 5.15.0-58-generic #64~20.04.1-Ubuntu SMP Fri Jan 6 16:42:31 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
|
|
|
|
Context:
|
|
I encountered a crash while using this 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](https://github.com/ayushsharma82/RPAsyncTCP/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!
|