Skip to content

Commit d5a9640

Browse files
softhack007coderabbitai[bot]Copilot
authored andcommitted
copilot-instructions rework, new C++ coding guide for AI reviews (wled#5480)
* comprehensive C++, Web UI, and CI/CD conventions, a condensed setup/build guide, and a new agent-mode build/test workflow with ordered commands, timeouts, validation gates, manual web validation, and troubleshooting steps. * repository-level AI review/configuration rules, workflow best-practices, safeguards to detect and flag edits to generated web assets, and alignment checks linking AI-facing rules with human-only reference sections. --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
1 parent b74a6d2 commit d5a9640

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ We'll work with you to refine your contribution, but we'll also push back if som
1010
Here are a few suggestions to make it easier for you to contribute:
1111

1212
### Important Developer Infos
13-
* [Project Structure, Files and Directories](https://github.com/wled/WLED/blob/main/.github/copilot-instructions.md#project-branch--release-structure) (in our AI instructions)
14-
* [Instructions for creating usermods](https://github.com/wled/WLED/blob/main/.github/copilot-instructions.md#adding-a-new-usermod) (in our AI instructions)
13+
* [Project Structure, Files and Directories](.github/copilot-instructions.md#project-structure-overview) (in our AI instructions)
14+
* [Instructions for creating usermods](.github/copilot-instructions.md#usermod-guidelines) (in our AI instructions)
1515
* KB: [Compiling WLED](https://kno.wled.ge/advanced/compiling-wled/) - slightly outdated but still helpful :-)
1616
* Arduino IDE is not supported any more. Use VSCode with the PlatformIO extension.
1717
* [Compiling in VSCode/Platformio](https://github.com/wled/WLED-Docs/issues/161) - modern way without command line or platformio.ini changes.
@@ -174,7 +174,12 @@ AI tools are powerful but "often wrong" - your judgment is essential! 😊
174174

175175
Don't stress too much about style! When in doubt, just match the style in the files you're editing. 😊
176176

177-
Here are our main guidelines:
177+
Our review bot (coderabbit) has learned lots of detailed guides and hints - it will suggest them automatically when you submit a PR for review.
178+
If you are curious, these are the detailed guides:
179+
* [C++ Coding](docs/cpp.instructions.md)
180+
* [WebUi: HTML, JS, CSS](docs/web.instructions.md)
181+
182+
Below are the main rules used in the WLED repository:
178183

179184
#### Indentation
180185

0 commit comments

Comments
 (0)