docs: add default issue template to require AI acknowledgment#19
docs: add default issue template to require AI acknowledgment#19lumirlumir wants to merge 2 commits intomasterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds default GitHub issue form templates (bug report, change request, documentation) to the .github community health files repository. Since this is the ESLint organization's shared .github repository, these templates will apply as defaults to all ESLint repositories that don't already have their own issue templates. The templates are based on the pattern used in the eslint/js repository and include AI acknowledgment checkboxes per the policy merged in eslint/eslint#20510. Additionally, VS Code editor configuration files are added to .gitignore.
Changes:
- Added three issue form templates (
bug-report.yml,change.yml,docs.yml) with AI acknowledgment checkboxes - Added
config.ymlto disable blank issues and provide a Discord contact link - Updated
.gitignoreto exclude VS Code editor configuration files
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/bug-report.yml |
New bug report template with environment info, reproduction link, and AI acknowledgment |
.github/ISSUE_TEMPLATE/change.yml |
New change request template for features/changes with AI acknowledgment |
.github/ISSUE_TEMPLATE/docs.yml |
New documentation issue template with AI acknowledgment |
.github/ISSUE_TEMPLATE/config.yml |
Disables blank issues and adds Discord contact link |
.gitignore |
Adds VS Code editor config files to ignore list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Prerequisites checklist
AI acknowledgment
What is the purpose of this pull request?
This PR adds default issue templates that require AI acknowledgment.
The PR for the AI usage policy (eslint/eslint#20510) has been merged, and it now requires disclosure of AI usage. However, some repositories like
eslint-github-bot,eslintrc, and others don't yet have issue templates.This is a problem because users can only open an empty issue template and there are no AI acknowledgment checkboxes by default.
I followed the template used by
js(https://github.com/eslint/js/tree/main/.github/ISSUE_TEMPLATE) and tweaked it slightly to serve as a general default template.Other opinions or feedback on the default template are welcome.
What changes did you make? (Give an overview)
This PR adds default issue templates that require AI acknowledgment.
Related Issues
Ref: eslint/eslint#20510
Is there anything you'd like reviewers to focus on?
The issue templates under
.github/ISSUE_TEMPLATEapply to all ESLint repositories. They are overridden by any existing templates, so repositories that already have their own issue templates won't be affected.