You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,4 +36,4 @@ Link any relevant issues that this PR addresses.
36
36
-[ ] Includes code generated or substantially modified by an AI agent
37
37
-[ ] Includes tests generated or substantially modified by an AI agent
38
38
39
-
> NOTE: the `Generated-by`and`Assisted-by`tags should be used in both git commit messages and docstrings to indicate when code or tests were generated or substantially modified by an AI agent, as described in the project's [`DEVELOPING.md`](https://github.com/vllm-project/guidellm/blob/main/DEVELOPING.md) file.
39
+
> NOTE: the `Generated-by`or`Assisted-by`trailers should be used in git commit messages when code or tests were generated or substantially modified by an AI agent, as described in the project's [`DEVELOPING.md`](https://github.com/vllm-project/guidellm/blob/main/DEVELOPING.md) file.
Copy file name to clipboardExpand all lines: DEVELOPING.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ The `-e` flag installs the package in editable mode, allowing you to make change
55
55
56
56
## Tag use of AI coding assistants
57
57
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 "trailer" tags to the git commit message. Git "trailers" are a series of key-value pairs appended to the end of the commit message, separated by a line break, including `Co-authored-by: <name> <email>` and `Signed-off-by: <name> <email>`. We use the keys `Generated-by` and `Assisted-by` to indicate when code or tests were generated or substantially modified by an AI agent.
58
+
When AI coding assistants are used to generate or substantially modify code, the GuideLLM project requires that you add one of the following trailers to the git commit message:
59
59
60
60
-`Generated-by: <name of the AI coding assistant>`: when the code in the commit was generated primarily by an AI coding assistant.
61
61
-`Assisted-by: <name of the AI coding assistant>`: when the commit includes substantial code created or modified by the AI coding assistant.
@@ -71,17 +71,15 @@ Generated-by: Cursor
71
71
Signed-off-by: John Doe <john.doe@example.com>
72
72
```
73
73
74
-
You can optionally add the LLM model name after the name of the AI coding assistant, separated by a comma or space.
74
+
You can optionally add the LLM model name after the name of the AI coding assistant, separated by a space.
75
75
76
76
For example:
77
77
78
78
```markdown
79
79
Generated-by: Cursor claude-4.6-sonnet
80
-
Assisted-by: GitHub Copilot, gpt-4o
80
+
Assisted-by: GitHub Copilot gpt-4o
81
81
```
82
82
83
-
Do not use the `Generated-by` and `Assisted-by` tags in code (comments, docstrings, etc.): as the code evolves, this sort of "origin" attribution can lose relevance and become noise.
84
-
85
83
## Running Quality, Style, and Type Checks
86
84
87
85
We use Tox to simplify running various tasks in isolated environments. Tox standardizes environments to ensure consistency across local development, CI/CD pipelines, and releases. This guarantees that the code behaves the same regardless of where it is executed.
0 commit comments