docs: use textarea for new rule details - #738
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe new-rule issue template uses a single-line input for “Rule details” and adds an optional “Additional rule details” textarea. ChangesRule Template
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to 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)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.
|
I would slightly -1 on this change. |
That makes sense. I agree and have updated the template accordingly. |
lumirlumir
left a comment
There was a problem hiding this comment.
LGTM, thanks!
Leaving it open for DMartens to verify before merging.
DMartens
left a comment
There was a problem hiding this comment.
Changes LGTM, thank you.
Prerequisites checklist
AI acknowledgment
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 detailssections.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 detailsfield 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