Skip to content

docs: Amend code generation guidelines to CONTRIBUTING.md#2628

Merged
xezon merged 2 commits intoTheSuperHackers:mainfrom
xezon:xezon/doc-contributing
Apr 20, 2026
Merged

docs: Amend code generation guidelines to CONTRIBUTING.md#2628
xezon merged 2 commits intoTheSuperHackers:mainfrom
xezon:xezon/doc-contributing

Conversation

@xezon
Copy link
Copy Markdown

@xezon xezon commented Apr 19, 2026

This change adds some sentences for generated code.

@xezon xezon added the Documentation Is documentation or complementary resource label Apr 19, 2026
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 19, 2026

Greptile Summary

This PR amends CONTRIBUTING.md to add a general contribution guidelines section and a new policy governing AI/LLM-assisted code generation, including requirements for author verification, testing, and disclosure in PRs. The content is clear and the policy is sensible, with only minor prose issues remaining (compound-adjective hyphenation, plus two spelling/pluralization items flagged in prior review threads).

Confidence Score: 5/5

Safe to merge once the minor prose issues (including the two from prior review threads) are addressed.

All findings are P2 style/grammar issues with no logic, correctness, or security implications. The policy content itself is well-formed and ready to merge.

CONTRIBUTING.md — minor prose fixes needed (hyphenation, previously flagged spelling/pluralization).

Important Files Changed

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
Loading
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

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@xezon xezon force-pushed the xezon/doc-contributing branch from 0677d73 to e4e112d Compare April 19, 2026 11:16
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown

@Skyaero42 Skyaero42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok

@xezon xezon merged commit 8a1d556 into TheSuperHackers:main Apr 20, 2026
17 checks passed
@xezon xezon deleted the xezon/doc-contributing branch April 20, 2026 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Is documentation or complementary resource

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants