Skip to content

Latest commit

 

History

History
70 lines (41 loc) · 4.13 KB

issues.md

File metadata and controls

70 lines (41 loc) · 4.13 KB
Raw

H4P Logo

Is it actually an "issue"?

Suggestions, improvements, specific changes / additions / requests etc are not "issues". If you want to discuss those matters, we would love you to join us in the Facebook H4 Support / Discussion group set up specifcially for that purpose.

"Issues" should be restricted to code not behaving as described, crashes, confusing / unclear / broken documentation etc. Keep it to things that simply just don't work, not "Things that don't work the way you would like them to or think they should".

Genuine Issues

The bottom line is: If I cannot find the problem, I can't fix it. This document explains the ways in which you can help me to find and fix any genuine bugs or other problems with the code.

If you raise an issue without providing the information outlined here, It will not be looked at, it's that simple. If you genuinely want your problem fixed, please provide all of the following where possible / relevant:

Mandatory steps

  1. Read all of the relevant documentation for the plugins you are using.

  2. Check the Known Issues / FAQs

  3. Provide the type / name of the development board you are using and the major Tools / Build settings from ArduinoIDE. Its not a huge effort, a small screen snip like this will suffice using snip or PrintScreen key DO NOT TAKE PHOTOS OF YOUR SCREEN. If it's a homebuild, include schematic or circuit diagram.

settings

  1. Edit config_plugins.h and ensure H4P_LOG_MESSAGES is set to 1 like so:
#define H4P_LOG_MESSAGES        1
  1. Change the mandatory preamble to the following and make sure your IDE and libraries are at the correct version levels as stated here before recompiling
#define H4P_VERBOSE 1
H4_USE_PLUGINS(115200,30,false)
H4P_SerialLogger sl;

  1. Include the cut and pasted text of the entire serial monitor output from the start of the boot. DO NOT TAKE PHOTOS OF YOUR SCREEN

  2. Include the entire code of the MVCE (see below) that shows the error, or a link to a repo or pastebin etc. If you are using additional libraries, include links so that I can download them too. If I can't compile and run your code, I can't find the bug.

  3. If the problem includes a crash, you must provide a decoded stack trace. A raw stack trace is useless and will just delay solving the problem. Do not include raw stack traces. You will need to download and install the ESP Exception Decoder

Your code - MVCE

Your code should be a Minimal, Complete and Verifiable Example (MCVE).

This means that I need to see everything ("complete") to be able to reproduce the problem, but I need "everything" to be as small as possible ("minimal"). Of course it must also actually show the problem clearly ("Verifiable").

When you explain the problem you should explain what you expect to happen and usually why. Then your MVCE should show a different result.

What's actually in an MCVE?

More important is what is not in it: and that is anything that does not contribute or work towards causing the problem. If I can take out any code and still compile the sketch and still have it show the problem, then it is not "minimal" and you should have already removed that code: don't make it hard work for me. The easier it is for me to see the problem, the quicker it will get fixed. If in doubt, TAKE IT OUT

(c) 2021 Phil Bowles [email protected]