docs: Amend code generation guidelines to CONTRIBUTING.md#2628
docs: Amend code generation guidelines to CONTRIBUTING.md#2628xezon merged 2 commits intoTheSuperHackers:mainfrom
Conversation
|
| Filename | Overview |
|---|---|
| CONTRIBUTING.md | Adds general contribution guidelines and AI/LLM code generation policy sections; contains a compound-adjective hyphenation issue ("LLM generated" → "LLM-generated") and two previously-flagged issues (spelling "extend"/"extent", pluralization "LLM's"/"LLMs") that are still unresolved. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Contributor] --> B{Using AI/LLM?}
B -- No --> C[Write code manually]
B -- Yes --> D[Generate code with LLM]
D --> E[Author verifies: human-readable, maintainable, logically correct]
E --> F[Author tests and verifies generated code]
F --> G[Author polishes code — NOT delegated to reviewers]
C --> H{Open Pull Request}
G --> H
H --> I[Announce LLM usage + extent of human polishing in PR]
I --> J{New contributor with large LLM-assisted PR?}
J -- Yes, thousands of lines --> K[Discouraged — reviewers cannot attend such volumes]
J -- No --> L[PR reviewed and potentially merged]
K --> M[Break into smaller, higher-quality PRs]
M --> L
Prompt To Fix All With AI
This is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 13
Comment:
**Missing hyphen in compound modifier "LLM-generated"**
When "LLM generated" is used as a compound adjective before a noun, it should be hyphenated: "LLM-generated code". The same applies to "AI generated code" in the section title above.
```suggestion
Creating changes with LLM-generated code is generally allowed. The author is responsible for verifying that all generated code is human readable, maintainable and logically correct. Furthermore, all generated code needs to be tested and verified. The author is not allowed to outsource the polishing of the generated code to the human code reviewers. In a Pull Request, generated code needs to be announced as such and to what extend it was polished by human intervention.
```
How can I resolve this? If you propose a fix, please make it concise.Reviews (3): Last reviewed commit: "Polish texts" | Re-trigger Greptile
0677d73 to
e4e112d
Compare
This change adds some sentences for generated code.