Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: recommend messageId over message for reporting rule violations #18050

Merged
merged 3 commits into from Jan 30, 2024

Conversation

bmish
Copy link
Sponsor Member

@bmish bmish commented Jan 29, 2024

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)

Fixes #17854.

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

@bmish bmish requested a review from a team as a code owner January 29, 2024 20:53
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Jan 29, 2024
Copy link

netlify bot commented Jan 29, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit be4d9db
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/65b936763ef13c0008c0489a
😎 Deploy Preview https://deploy-preview-18050--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 site configuration.

Copy link
Member

@aladdin-add aladdin-add left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! waiting for a few more review before merging.

@amareshsm amareshsm added the accepted There is consensus among the team that this change meets the criteria for inclusion label Jan 30, 2024
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

LGTM!

Just one suggestion, not blocking at all IMO.

docs/src/extend/custom-rules.md Outdated Show resolved Hide resolved
docs/src/extend/custom-rules.md Outdated Show resolved Hide resolved
bmish and others added 2 commits January 30, 2024 12:48
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@nzakas nzakas merged commit 10485e8 into eslint:main Jan 30, 2024
18 checks passed
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: Complete
Development

Successfully merging this pull request may close these issues.

Docs: Explicitly state a preference for messageId vs message in custom rules docs
5 participants