Skip to content

Commit c40caf6

Browse files
committed
Iterate
Signed-off-by: David Butenhof <dbutenho@redhat.com>
1 parent 486577b commit c40caf6

2 files changed

Lines changed: 4 additions & 6 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ Link any relevant issues that this PR addresses.
3636
- [ ] Includes code generated or substantially modified by an AI agent
3737
- [ ] Includes tests generated or substantially modified by an AI agent
3838

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.

DEVELOPING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ 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 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:
5959

6060
- `Generated-by: <name of the AI coding assistant>`: when the code in the commit was generated primarily by an AI coding assistant.
6161
- `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
7171
Signed-off-by: John Doe <john.doe@example.com>
7272
```
7373

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.
7575

7676
For example:
7777

7878
```markdown
7979
Generated-by: Cursor claude-4.6-sonnet
80-
Assisted-by: GitHub Copilot, gpt-4o
80+
Assisted-by: GitHub Copilot gpt-4o
8181
```
8282

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-
8583
## Running Quality, Style, and Type Checks
8684

8785
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

Comments
 (0)