wartana/WLED
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md with AI usage guidelines

Browse Source 
Added guidelines for contributions involving AI assistance.
This commit is contained in:
Frank
2025-12-03 15:13:38 +01:00
committed by GitHub
parent 8cbc76540f
commit e6b5429873
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@@ -29,6 +29,23 @@ Github will pick up the changes so your PR stays up-to-date.
You can find a collection of very useful tips and tricks here: https://github.com/wled-dev/WLED/wiki/How-to-properly-submit-a-PR You can find a collection of very useful tips and tricks here: https://github.com/wled-dev/WLED/wiki/How-to-properly-submit-a-PR
### Source Code from an AI agent or bot
> [!IMPORTANT]
> Its OK if you took help from an AI for writing your source code.
>
> However, we expect a few things from you as the person making a contribution to WLED:
* Make sure you really understand the code suggested by the AI, and don't just accept it because it "seems to work".
* Don't let the AI change already exists without double-checking by you as the contributor. Often, the result will not be complete. For example, comments about the source code may be lost.
* Remember that AI are still "Often-Wrong" ;-)
* If you don't feel very confident using English, you can AI for translating code comments and descriptions into English. AI bots are very good at understanding language. However, always check the results in correct. The translation might still have wrong technical terms, or errors in some details.
#### best practice with AI:
* As the person who contributes the code to WLED, make sure you understand exactly what the AI code does
* add a comment like ``'// below section of my code was generated by an AI``, when larger parts of your source code were not written by you personally.
* always review translations and code comments for correctness
* If the AI has rewritten existing code, check that the change is necessary and that nothing has been lost or broken. Also check that previous code comments are still intact.
### Code style ### Code style