|
| 1 | +## Contributing to Teensy_PWM |
| 2 | + |
| 3 | +### Reporting Bugs |
| 4 | + |
| 5 | +Please report bugs in Teensy_PWM 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/Teensy_PWM/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/Teensy_PWM/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.19) or Platform.io version |
| 18 | +* `Teensyduino` Core Version (e.g. Teensy core v1.57) |
| 19 | +* Contextual information (e.g. what you were trying to achieve) |
| 20 | +* Simplest possible steps to reproduce |
| 21 | +* Anything that might be relevant in your opinion, such as: |
| 22 | + * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a` |
| 23 | + * Network configuration |
| 24 | + |
| 25 | + |
| 26 | +### Example |
| 27 | + |
| 28 | +``` |
| 29 | +Arduino IDE version: 1.8.19 |
| 30 | +Teensyduino Core Version 1.57 |
| 31 | +OS: Ubuntu 20.04 LTS |
| 32 | +Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux |
| 33 | +
|
| 34 | +Context: |
| 35 | +I encountered a crash while using this library |
| 36 | +
|
| 37 | +Steps to reproduce: |
| 38 | +1. ... |
| 39 | +2. ... |
| 40 | +3. ... |
| 41 | +4. ... |
| 42 | +``` |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +### Sending Feature Requests |
| 47 | + |
| 48 | +Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful. |
| 49 | + |
| 50 | +There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/Teensy_PWM/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them. |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +### Sending Pull Requests |
| 55 | + |
| 56 | +Pull Requests with changes and fixes are also welcome! |
| 57 | + |
| 58 | +Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux) |
| 59 | + |
| 60 | +1. Change directory to the library GitHub |
| 61 | + |
| 62 | +``` |
| 63 | +xy@xy-Inspiron-3593:~$ cd Arduino/xy/Teensy_PWM_GitHub/ |
| 64 | +xy@xy-Inspiron-3593:~/Arduino/xy/Teensy_PWM_GitHub$ |
| 65 | +``` |
| 66 | + |
| 67 | +2. Issue astyle command |
| 68 | + |
| 69 | +``` |
| 70 | +xy@xy-Inspiron-3593:~/Arduino/xy/Teensy_PWM_GitHub$ bash utils/restyle.sh |
| 71 | +``` |
0 commit comments