Skip to content

Commit 36241e8

Browse files
committed
AI instructions update (sync with upstream)
1 parent 6740583 commit 36241e8

2 files changed

Lines changed: 31 additions & 2 deletions

File tree

.coderabbit.yaml

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,19 @@
1717
language: en-US
1818

1919
reviews:
20+
# generic review setting, see https://docs.coderabbit.ai/reference/configuration#reference
21+
auto_apply_labels: true
22+
# abort_on_close: false
23+
high_level_summary: true
24+
review_status: true
25+
collapse_walkthrough: false
26+
poem: false
27+
# sequence_diagrams: false
28+
auto_review:
29+
enabled: true
30+
ignore_title_keywords:
31+
- WIP
32+
2033
path_instructions:
2134
- path: "**/*.{cpp,h,hpp,ino}"
2235
instructions: >
@@ -39,7 +52,7 @@ reviews:
3952
Follow the web UI conventions documented in docs/web.instructions.md.
4053
4154
Key rules: indent HTML and JavaScript with tabs, CSS with tabs or spaces.
42-
Files here are built into wled00/html_*.h by tools/cdata.js — never
55+
Files here are built into wled00/html_*.h and wled00/js_*.h by tools/cdata.js — never
4356
edit those generated headers directly.
4457
4558
- path: "wled00/html_*.h"
@@ -48,6 +61,12 @@ reviews:
4861
They must never be manually edited or committed. Flag any PR that
4962
includes changes to these files.
5063
64+
- path: "wled00/js_*.h"
65+
instructions: >
66+
These files are auto-generated from wled00/data/ by tools/cdata.js.
67+
They must never be manually edited or committed. Flag any PR that
68+
includes changes to these files.
69+
5170
- path: "usermods/**"
5271
instructions: >
5372
Usermods are community add-ons following the upstream WLED 0.15.x style.
@@ -82,3 +101,13 @@ reviews:
82101
AI-facing rules due to edits introduced in this PR.
83102
3. If new AI-facing rules were added without updating a related HUMAN_ONLY
84103
reference section, note this as a suggestion (not a required fix).
104+
105+
finishing_touches:
106+
# Docstrings | Options for generating Docstrings for your PRs/MRs.
107+
docstrings:
108+
# Docstrings | Allow CodeRabbit to generate docstrings for PRs/MRs.
109+
# default: true - disabled in WLED-MM: has caused confusion in the past
110+
enabled: false
111+
unit_tests:
112+
# default: true - disabled in WLED-MM: we don't have a unit test framework, this option just confuses contributors
113+
enabled: false

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ docs/ # Coding convention docs
9494
### Error Handling
9595
- **No C++ exceptions** — some builds disable them
9696
- Use return codes (`false`, `-1`) and global flags (`errorFlag = ERR_LOW_MEM`)
97-
- Use early returns as guard clauses: `if (!enabled || strip.isUpdating()) return;`
97+
- Use early returns as guard clauses: `if (!enabled || (strip.isUpdating() && (millis() - last_time < MAX_USERMOD_DELAY))) return;`
9898
- Debug output: `DEBUG_PRINTF()` / `DEBUG_PRINTLN()` (compiled out unless `-D WLED_DEBUG`)
9999

100100
### Strings and Memory

0 commit comments

Comments
 (0)