Skip to content

docs: use textarea for new rule details - #738

Merged
DMartens merged 3 commits into
eslint:mainfrom
tooth-is-silver:docs/update-new-rule-issue-template
Sep 22, 2026
Merged

DMartens merged 3 commits into
eslint:mainfrom
tooth-is-silver:docs/update-new-rule-issue-template

Conversation

@tooth-is-silver

@tooth-is-silver tooth-is-silver commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

Prerequisites checklist

AI acknowledgment

  • I did not use AI to generate this PR.
  • (If the above is not checked) I have reviewed the AI-generated content before submitting.

What is the purpose of this pull request?

New rule proposals often require more than one line of explanation. For example, #735, #700, and #694 contain multi-sentence Rule details sections.

A Markdown textarea is more suitable for descriptions of this length than a single-line input.

What changes did you make? (Give an overview)

Changed the Rule details field in the new rule issue form from an input to a textarea.

Related Issues

N/A

Is there anything you'd like reviewers to focus on?

N/A

Disclosure: I'm a participant of open source contribution program OSSCA

Summary by CodeRabbit

  • Documentation
    • Updated the new-rule issue template so “Rule details” uses a single-line input for brief responses.
    • Added an optional “Additional rule details” field immediately afterward, allowing users to provide longer, multi-line explanations when needed.
    • The template now supports both concise rule descriptions and supplementary context without requiring additional fields for users who do not need them.

@coderabbitai

coderabbitai Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: edab4f9c-59bb-4638-a7e0-a2f88b3a2176

📥 Commits

Reviewing files that changed from the base of the PR and between cff1fec and b0dd090.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/new-rule.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/ISSUE_TEMPLATE/new-rule.yml

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The new-rule issue template uses a single-line input for “Rule details” and adds an optional “Additional rule details” textarea.

Changes

Rule Template

Layer / File(s) Summary
Rule details fields
.github/ISSUE_TEMPLATE/new-rule.yml
The “Rule details” field uses a single-line input. The template adds an optional “Additional rule details” textarea for extra rule behavior details.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Suggested reviewers: lumirlumir

Merge Risk: ⚪ Minimal · up to b0dd0

The template change separates concise rule details from optional extended details without an identified merge-blocking issue.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title is misleading. The change keeps Rule details as a single-line input and adds a separate Additional rule details textarea. Rename the title to describe the separate textarea, for example: docs: add textarea for additional rule details.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@eslintbot eslintbot added this to Triage Sep 16, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Triage Sep 16, 2026
@tooth-is-silver tooth-is-silver changed the title docs: use textarea for new rule details- #730 docs: use textarea for new rule details Sep 16, 2026
@lumirlumir lumirlumir moved this from Needs Triage to Triaging in Triage Sep 16, 2026

@lumirlumir lumirlumir left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Disclosure: I'm a participant of open source contribution program OSSCA: confirmed.

Thanks for the PR. I actually don’t feel strongly about this change.

Looking at the previous issues from the issue search, I found that many new rule requests use only a single line for the “Rule details” section, while others clearly need more.

So, I think this is a matter of preference. I’m leaving it open so others can review it and we can reach a consensus.

@lumirlumir lumirlumir moved this from Triaging to Evaluating in Triage Sep 16, 2026
@DMartens

Copy link
Copy Markdown
Contributor

I would slightly -1 on this change.
The input forces a short rule description (similar to the rule.meta.docs.description) which helps grasping the idea / give a high-level overview over what is proposed.
Rather I think we should update "Additional comments" to specifically mention that rule details can be added there or add a section specifically for this.

@tooth-is-silver

Copy link
Copy Markdown
Contributor Author

Rather I think we should update "Additional comments" to specifically mention that rule details can be added there or add a section specifically for this.

That makes sense. I agree and have updated the template accordingly.
Updated in cff1fec!

Comment thread .github/ISSUE_TEMPLATE/new-rule.yml Outdated
@lumirlumir lumirlumir moved this from Evaluating to Implementing in Triage Sep 18, 2026

@lumirlumir lumirlumir left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks!

Leaving it open for DMartens to verify before merging.

@lumirlumir lumirlumir moved this from Implementing to Second Review Needed in Triage Sep 18, 2026
@lumirlumir
lumirlumir requested a review from DMartens September 18, 2026 14:18

@DMartens DMartens left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changes LGTM, thank you.

@DMartens
DMartens merged commit 256337e into eslint:main Sep 22, 2026
40 checks passed
@github-project-automation github-project-automation Bot moved this from Second Review Needed to Complete in Triage Sep 22, 2026
@tooth-is-silver
tooth-is-silver deleted the docs/update-new-rule-issue-template branch September 23, 2026 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

4 participants