From 19105831c90783a1f5eb5a66558ff7fb066f5a97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20M=C3=B6hle?= <91616163+softhack007@users.noreply.github.com> Date: Sat, 4 Apr 2026 03:34:23 +0200 Subject: [PATCH] Update CONTRIBUTING.md Updated links in the contributing guide and added information about coding style and review bot. --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d9cfd65..9b82e59f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Here are a few suggestions to make it easier for you to contribute! ## Important Developer Infos -* [Project Structure, Files and Directories](https://github.com/MoonModules/WLED-MM/blob/mdev/.github/copilot-instructions.md#project-branch--release-structure) (in our AI instructions) +* [Project Structure, Files and Directories](https://github.com/MoonModules/WLED-MM/blob/mdev/.github/copilot-instructions.md#repository-structure) (in our AI instructions) * KB: [Compiling WLED](https://kno.wled.ge/advanced/compiling-wled/) - slightly outdated but still helpful 😊 * Arduino IDE is not supported any more. Use VSCode with the PlatformIO extension. * [Compiling in VSCode/Platformio](https://github.com/wled/WLED-Docs/issues/161) - modern way. @@ -70,8 +70,17 @@ You can find a collection of very useful tips and tricks here: https://github.co ## Code style +Don't stress too much about coding style. When in doubt, it is easiest to replicate the code style you find in the files you want to edit :) -Below are the guidelines we use in the WLED repository. + +Our review bot (coderabbit) has learned lots of detailed guides and hits - it will suggest them automatically when you submit a PR for review. + +If you are curious, these are the detailed guides: +* [C++ Coding](https://github.com/MoonModules/WLED-MM/blob/mdev/.github/cpp.instructions.md) +* [WebUi: HTML, JS, CSS](https://github.com/MoonModules/WLED-MM/blob/mdev/.github/web.instructions.md) +* [Using ESP-IDF directly](https://github.com/MoonModules/WLED-MM/blob/mdev/.github/esp-idf.instructions.md) + +Below are the main rules used the WLED-MM repository. ### Indentation