Skip to content

docs: add AI acknowledgement section to templates#20431

Open
lumirlumir wants to merge 11 commits intomainfrom
docs/add-ai-acknowledgement
Open

docs: add AI acknowledgement section to templates#20431
lumirlumir wants to merge 11 commits intomainfrom
docs/add-ai-acknowledgement

Conversation

@lumirlumir
Copy link
Member

@lumirlumir lumirlumir commented Jan 10, 2026

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

@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Jan 10, 2026
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Jan 10, 2026
@netlify
Copy link

netlify bot commented Jan 10, 2026

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 4fdaf91
🔍 Latest deploy log https://app.netlify.com/projects/docs-eslint/deploys/698831963b6c9600087ae2e6
😎 Deploy Preview https://deploy-preview-20431--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lumirlumir lumirlumir force-pushed the docs/add-ai-acknowledgement branch from 38e4f49 to ff5a2e5 Compare January 10, 2026 13:42
@lumirlumir lumirlumir marked this pull request as ready for review January 10, 2026 13:57
@lumirlumir lumirlumir requested a review from a team as a code owner January 10, 2026 13:57
Copilot AI review requested due to automatic review settings January 10, 2026 13:57
@lumirlumir lumirlumir added the accepted There is consensus among the team that this change meets the criteria for inclusion label Jan 10, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@lumirlumir
Copy link
Member Author

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@lumirlumir lumirlumir Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I've checked both options in the issue template UI, it looks like this:

Dropdown

image

Checkbox

image

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to use dropdown here.

Copy link
Member Author

@lumirlumir lumirlumir Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@lumirlumir lumirlumir force-pushed the docs/add-ai-acknowledgement branch from 1b2bdb6 to 86e1b19 Compare January 22, 2026 14:20
@lumirlumir
Copy link
Member Author

The Netlify CI failure seems to be a temporary issue.

@amareshsm amareshsm linked an issue Jan 27, 2026 that may be closed by this pull request
1 task
@amareshsm amareshsm moved this from Needs Triage to Triaging in Triage Jan 27, 2026
@lumirlumir
Copy link
Member Author

lumirlumir commented Feb 8, 2026

Thanks for linking this to #20355! That said, I’ve unlinked it because #20355 applies to all ESLint repositories. I’ll mark that issue as closed after I follow up across all repositories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation

Projects

Status: Triaging

Development

Successfully merging this pull request may close these issues.

5 participants