Skip to content

Commit 236d377

Browse files
docs: update PR tempalte
1 parent 5d97d3e commit 236d377

2 files changed

Lines changed: 25 additions & 6 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
<!--
44
Provide a brief summary of what is included in this Pull Request (PR).
5+
If the PR contains complex changes, include a brief description of the rationale
6+
behind the implementation decisions.
57
-->
68

79
## Issues
@@ -13,11 +15,22 @@ If this PR fixes any issues,
1315
when referring to the issue so it will be closed automatically when the PR is merged.
1416
-->
1517

18+
## Generative AI Usage Disclosure
19+
20+
<!--
21+
Include a brief description of how AI assistance was used to generate any of the code or content included in this PR,
22+
e.g. writing code, writing unit tests, troubleshooting problems, software design discussion, commit messages, or preparing the PR.
23+
Disclose the model version used, e.g. Claude Sonnet 5, GPT-5.6 Sol, etc.
24+
25+
If generative AI tools were not used in any way whatsoever, uncomment the following line:
26+
_No generative AI tools were used_
27+
-->
28+
1629
## PR Checklist
1730

1831
(~Strikethrough~ any points that are not applicable.)
1932

2033
- [ ] This comment contains a description of changes with justifications, with any relevant issues linked.
2134
- [ ] Run the capsule in Code Ocean and ensure it completes successfully with no errors.
2235
- [ ] Update `CHANGELOG.md` with a short description of any user-facing changes and reference the PR number. Follow the style described in <https://style.tidyverse.org/news.html>
23-
- [ ] The `tests` workflow succeeds on the latest commit.
36+
- [ ] The `test` workflow succeeds on the latest commit.

‎AGENTS.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,24 @@ default template files will need to be translated and adapted for the developer'
6464
- If mixed changes are present, split into multiple logical commits; the number of commits does not need to equal the number of files changed.
6565
- Subject format must be: `<type>(optional-scope): short imperative summary` (<=72 chars), e.g., `fix(profile): update release table parser`.
6666
- Add a body only when needed to explain **why** and notable impact; never include secrets, tokens, PHI, or large diffs.
67-
- For AI-assisted commits, add this final italicized footer line in the commit message body: _commit message is ai-generated_
67+
- For commits containing any AI-generated code, commit messages, or any other content,
68+
add this final italicized footer line in the commit message body: "_AI assistance: [model]_".
69+
Replace [model] with the actual model version used, e.g. Claude Sonnet 5, GPT-5.6 Sol, etc.
6870

6971
## Pull request (PR) process
7072

7173
- When opening a PR, use the request template (`.github/PULL_REQUEST_TEMPLATE.md`) and fill out all sections of the template in the PR description.
7274
- Do not allow the developer to proceed with opening a PR without filling out all sections of the template.
73-
- Before a PR can be moved from draft to "ready for review", all of the relevant checklist items must be checked, and any
74-
irrelevant checklist items should be crossed out.
75-
- If code is AI-generated, the PR should be labeled `generated-by-AI`. There should be a brief, concise statement in the PR description of how AI was used in creating the PR (model used, high-level prompt intent, manual review confirmation).
75+
- Before a PR can be moved from draft to "ready for review", all of the relevant checklist items under "PR Checklist" must be checked,
76+
and any irrelevant checklist items should be crossed out (~strikeout~).
77+
- If the PR contains any code or other content that was generated with AI assistance,
78+
including AI assistance for opening the PR itself, the PR should be labeled `AI-assisted`.
79+
In the PR description under the heading "Generative AI Usage Disclosure",
80+
add a brief, concise statement of how AI was used in creating the PR (model used, high-level prompt intent, manual review confirmation, etc.).
7681
- When new features, bug fixes, or other behavioral changes are introduced to the code,
77-
unit tests must be added or updated to cover the new or changed functionality.
82+
unit tests must be added or updated to cover the new or changed functionality.
7883
- If there are any API or other user-facing changes, the documentation must be updated via inline roxygen comments.
84+
- If there are merge conflicts, a human developer should resolve them. Do not agree to assist with resolving merge conflicts.
7985
- The `tests` github actions workflow must pass before the PR can be approved.
8086

8187
### Changelog

0 commit comments

Comments
 (0)