Skip to content

Commit 33ff420

Browse files
committed
Review comments
Signed-off-by: David Butenhof <dbutenho@redhat.com>
1 parent 46a4f9f commit 33ff420

1 file changed

Lines changed: 11 additions & 21 deletions

File tree

DEVELOPING.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -55,40 +55,30 @@ The `-e` flag installs the package in editable mode, allowing you to make change
5555

5656
## Tag use of AI coding assistants
5757

58-
When using AI coding assistants to generate any substantive code, you must add the following tag to the commit message:
58+
When AI coding assistants are used to generate or modify substantive code, the GuideLLM project requires that you add one of the following two tags to the commit message:
5959

60-
```markdown
61-
Assisted-by: <name of the AI coding assistant>
62-
```
63-
64-
You can optionally add the LLM model name after the name of the AI coding assistant for clarity.
60+
- `Generated-by: <name of the AI coding assistant>`: when the commit was generated primarily by the AI coding assistant.
61+
- `Assisted-by: <name of the AI coding assistant>`: when the commit includes substantial code created or modified by the AI coding assistant.
6562

6663
For example:
6764

6865
```markdown
69-
Assisted-by: Cursor
70-
Assisted-by: GitHub Copilot gpt-4o
71-
Assisted-by: Claude claude-3-5-sonnet-20240620
72-
Assisted-by: gemini-code-assist gemini-2.5-flash
73-
Assisted-by: openai-code-assist gpt-4o
66+
Generated-by: Cursor
67+
Assisted-by: GitHub Copilot
7468
```
7569

76-
This does not apply to minor changes such as fixing typos, formatting, or small AI generated autocompletion suggestions that do not constitute substantive code.
77-
78-
You may instead use the Generated-by tag to clarify that the commit was generated entirely by the AI coding assistant:
79-
80-
```markdown
81-
Generated-by: <name of the AI coding assistant>
82-
```
70+
You can optionally add the LLM model name after the name of the AI coding assistant for clarity, separated by a comma or space. (Do not enclose the model name in angle brackets, like `<gpt-4o>`, because GitHub will parse it as an email address.)
8371

8472
For example:
8573

8674
```markdown
87-
Generated-by: Cursor
88-
Generated-by: GitHub Copilot gpt-4o
75+
Generated-by: Cursor claude-4.6-sonnet
76+
Assisted-by: GitHub Copilot gpt-4o
8977
```
9078

91-
Use of the Assisted-by or Generated-by tags in code (comments, docstrings, etc.), where an AI assistant has generated or substantially modified a function, class, or module, is optional but encouraged for clarity and transparency.
79+
This rule does not apply to minor changes such as fixing typos, formatting, or isolated AI generated syntax suggestions that do not constitute substantive logic.
80+
81+
Use of the Generated-by and Assisted-by tags in code (comments, docstrings, etc.) is strongly encouraged, to help identify where an AI assistant has generated or substantially modified a function, class, or module. GuideLLM has also recognized the tag `## WRITTEN BY AI ##` in a docstring or comment to indicate that test cases were written by an AI assistant, but `Generated-by <assistant>` or `Assisted-by <assistant>` are preferred for clarity and consistency.
9282

9383
## Running Quality, Style, and Type Checks
9484

0 commit comments

Comments
 (0)