Add developer contributor guidelines to build and test our PR locally

[mathieucarbou]

Description

Hello,

I am preparing a PR to contribute middleware support (aka Expressif) to WebServer, plus some examples and middleware implementations (cors, security, logging).

I didn't find any guidelines explaining the process to compile our changes and test the examples we write on a real board before submitting the PR.

Right now, I work around that by adding some platformio.ini files and using PIO to build the examples, but this is quite a hack.

What contributors should do to locally test and run the examples we write against the modifications we did ?

Thanks :-)

I have checked existing issues, online documentation and the Troubleshooting Guide

• I confirm I have checked existing issues, online documentation and Troubleshooting guide.

[me-no-dev]

@lucasssvaz @P-R-O-C-H-Y any way this can be tested with wokwi?

[Jason2866]

@mathieucarbou Thx, for bringing this up. After the big refactoring of the GH Actions (btw. great work imho) i do not manage to test my changes anymore before opening a PR ;-)

[mathieucarbou]

@mathieucarbou Thx, for bringing this up. After the big refactoring of the GH Actions (btw. great work imho) i do not manage to test my changes anymore before opening a PR ;-)

I've tried running github/scripts/on-push.sh locally, it succeeded, which proves it didn't consider my changes... 🤣

So right now I am "working" with this simple pio file put inside libraries/WebServer:

[platformio]
lib_dir = .
src_dir = examples/Middleware

[env]
platform = espressif32
framework = arduino
board = esp32dev
monitor_speed = 115200
monitor_filters = esp32_exception_decoder
lib_ldf_mode = chain
lib_compat_mode = strict
build_flags =
    -Wall
    -Wextra
    -Og
    -D CONFIG_ARDUHAL_LOG_COLORS
    -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_VERBOSE

[env:arduino3]
platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.04/platform-espressif32.zip