jeans/WLED
1
0
Fork 0
mirror of https://github.com/wled/WLED.git synced 2026-04-22 07:02:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use same AI: comment as suggested in other agent instructions

Browse Source 
Exact comment text
This commit is contained in:
Frank Möhle
2026-04-11 23:50:53 +02:00
committed by GitHub
parent 7932a249e0
commit 14f2ca4223
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/copilot-instructions.md vendored
View File

@@ -123,7 +123,7 @@ Refer to `docs/cpp.instructions.md` and `docs/web.instructions.md` for language-
### Attribution for AI-generated code
Using AI-generated code can hide the source of the inspiration / knowledge / sources it used.
- Document attribution of inspiration / knowledge / sources used in the code, e.g. link to GitHub repositories or other websites describing the principles / algorithms used.
- When a larger block of code is generated by an AI tool, mark it with an `// AI: below section was generated by an AI` comment (see C++ guidelines).
- When a larger block of code is generated by an AI tool, embed it into `// AI: below section was generated by an AI` ... `// AI: end`` comments (see C++ guidelines).
- Every non-trivial AI-generated function should have a brief comment describing what it does. Explain parameters when their names alone are not self-explanatory.
- AI-generated code must be well documented with meaningful comments that explain intent, assumptions, and non-obvious logic. Do not rephrase source code; explain concepts and reasoning.