|
| 1 | +## Contributing to WiFiManager_Portenta_H7_Lite |
| 2 | + |
| 3 | +### Reporting Bugs |
| 4 | + |
| 5 | +Please report bugs in [WiFiManager_Portenta_H7_Lite](https://github.com/khoih-prog/WiFiManager_Portenta_H7_Lite/issues/new) if you find them. |
| 6 | + |
| 7 | +However, before reporting a bug please check through the following: |
| 8 | + |
| 9 | +* [Existing Open Issues](https://github.com/khoih-prog/WiFiManager_Portenta_H7_Lite/issues) - someone might have already encountered this. |
| 10 | + |
| 11 | +If you don't find anything, please [open a new issue](https://github.com/khoih-prog/WiFiManager_Portenta_H7_Lite/issues/new). |
| 12 | + |
| 13 | +### How to submit a bug report |
| 14 | + |
| 15 | +Please ensure to specify the following: |
| 16 | + |
| 17 | +* Arduino IDE version (e.g. 1.8.16) or Platform.io version |
| 18 | +* `ArduinoCore-mbed` Core Version (e.g. `ArduinoCore-mbed` mbed_portenta core v2.4.1) |
| 19 | +* `Portenta_H7` Board type (e.g. Portenta_H7 Rev2 ABX00042, etc.) |
| 20 | +* Contextual information (e.g. what you were trying to achieve) |
| 21 | +* Simplest possible steps to reproduce |
| 22 | +* Anything that might be relevant in your opinion, such as: |
| 23 | + * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a` |
| 24 | + * Network configuration |
| 25 | + |
| 26 | + |
| 27 | +### Example |
| 28 | + |
| 29 | +``` |
| 30 | +Arduino IDE version: 1.8.16 |
| 31 | +`ArduinoCore-mbed` mbed_portenta core v2.4.1 |
| 32 | +Portenta_H7 Rev2 ABX00042 |
| 33 | +OS: Ubuntu 20.04 LTS |
| 34 | +Linux xy-Inspiron-3593 5.4.0-84-generic #94-Ubuntu SMP Thu Aug 26 20:27:37 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux |
| 35 | +
|
| 36 | +Context: |
| 37 | +I encountered a crash while using TimerInterrupt. |
| 38 | +
|
| 39 | +Steps to reproduce: |
| 40 | +1. ... |
| 41 | +2. ... |
| 42 | +3. ... |
| 43 | +4. ... |
| 44 | +``` |
| 45 | + |
| 46 | + |
| 47 | +### Sending Feature Requests |
| 48 | + |
| 49 | +Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful. |
| 50 | + |
| 51 | +There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/WiFiManager_Portenta_H7_Lite/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them. |
| 52 | + |
| 53 | +### Sending Pull Requests |
| 54 | + |
| 55 | +Pull Requests with changes and fixes are also welcome! |
0 commit comments