Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.

Latest commit

 

History

History
79 lines (49 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

79 lines (49 loc) · 2.41 KB
Raw

Contributing to AsyncMQTT_Generic

Reporting Bugs

Please report bugs in AsyncMQTT_Generic if you find them.

However, before reporting a bug please check through the following:

If you don't find anything, please open a new issue.

How to submit a bug report

Please ensure to specify the following:

  • Arduino IDE version (e.g. 1.8.19) or Platform.io version
  • ESP8266,ESP32, STM32, arduino-pico or Teensyduino Core Version (e.g. ESP8266 core v3.1.1, ESP32 v2.0.6, STM32 v2.4.0, arduino-pico v2.7.1 or Teensyduino v1.57)
  • 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 will be ignored and deleted.

Example

Arduino IDE version: 1.8.19
ESP32 Core Version 2.0.6
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, feel free to add comments to them.

Sending Pull Requests

Pull Requests with changes and fixes are also welcome!

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/AsyncMQTT_Generic_GitHub/
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncMQTT_Generic_GitHub$
  1. Issue astyle command
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncMQTT_Generic_GitHub$ bash utils/restyle.sh