docs: add AI acknowledgement section to templates#20431
docs: add AI acknowledgement section to templates#20431lumirlumir wants to merge 11 commits intomainfrom
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
38e4f49 to
ff5a2e5
Compare
There was a problem hiding this comment.
Pull request overview
This pull request adds AI acknowledgement sections to all GitHub issue and pull request templates, allowing contributors to indicate whether they used AI assistance in creating their submissions.
Changes:
- Added AI acknowledgement checkbox section to the pull request template
- Added AI acknowledgment checkbox sections to all six issue templates (bug-report, change, docs, new-rule, new-syntax, and rule-change)
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/PULL_REQUEST_TEMPLATE.md | Added "AI acknowledgement" section with two checkboxes for declaring AI usage and review status |
| .github/ISSUE_TEMPLATE/bug-report.yml | Added "AI acknowledgment" checkboxes section after participation section |
| .github/ISSUE_TEMPLATE/change.yml | Added "AI acknowledgment" checkboxes section after participation section |
| .github/ISSUE_TEMPLATE/docs.yml | Added "AI acknowledgment" checkboxes section after participation section |
| .github/ISSUE_TEMPLATE/new-rule.yml | Added "AI acknowledgment" checkboxes section after participation section |
| .github/ISSUE_TEMPLATE/new-syntax.yml | Added "AI acknowledgment" checkboxes section after participation section |
| .github/ISSUE_TEMPLATE/rule-change.yml | Added "AI acknowledgment" checkboxes section after participation section |
|
Friendly ping @eslint/eslint-team |
| - type: markdown | ||
| attributes: | ||
| value: Please **do not** open a pull request until this issue has been accepted by the team. | ||
| - type: checkboxes |
There was a problem hiding this comment.
I think we want that exactly one of the two checkboxes is ticked.
I could not find documentation for this but this does not seem to be possible with "type: checkbox" but would require to use "type: dropdown".
Alternatively we could use a GitHub action to enforce this requirement.
There was a problem hiding this comment.
Okay, I've checked both options in the issue template UI, it looks like this:
Dropdown
Checkbox
After looking at the issue template UI, I'm not sure a dropdown is the best choice here.
Or maybe shortening the AI acknowledgment section description could be another option if we want to use the dropdown menu.
Other feedback is welcome.
There was a problem hiding this comment.
I feel that using a dropdown works well here. It allows us to require a selection and ensures that exactly one option is chosen, which isn’t something we can reliably enforce with checkboxes.
we can keep short labels for the dropdown and put a detailed explanation in the field description.
- type: dropdown
attributes:
label: AI acknowledgment
description: >
Select an option. If AI was used, ensure you reviewed all AI-generated content.
options:
- No AI
- AI used
validations:
required: true
There was a problem hiding this comment.
Okay great! Just to double-check:
-
For the issue templates: use a "No AI" / "AI used" dropdown menu.
-
For the PR template: use the existing checkbox style I suggested.
Is that the direction we want to go?
There was a problem hiding this comment.
I should've been more clear: the requirement that only one option is selected can be solved with a dropdown but personally I think checkboxes with a Github Action checking that one option is selected would be better as a dropdown with only two options feels weird.
There was a problem hiding this comment.
Could @eslint/eslint-tsc chime in to provide clear direction on how we should proceed?
There are several opinions but no definitive consensus, so I'm unsure which direction to take.
There was a problem hiding this comment.
Let's use the checkboxes.
My reason: Dropdowns always have a default value selected so it can be easy to overlook and skip. The checkboxes are a lot more obvious.
1b2bdb6 to
86e1b19
Compare
|
The Netlify CI failure seems to be a temporary issue. |
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
In this PR, I've resolved the issue mentioned in #20355.
I think it would be helpful to discuss the specific template we'll use here.
Is there anything you'd like reviewers to focus on?
Ref: #20355