Skip to content

feat: add url and recommended field to existing rules #104

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

Merged
merged 5 commits into from
May 28, 2025

Conversation

lumirlumir
Copy link
Member

Prerequisites checklist

What is the purpose of this pull request?

Hello,

In this PR, I've added the url field to existing rules.

The links reference the documentation shown in the screenshot below:

image

What changes did you make? (Give an overview)

Related Issues

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

@github-project-automation github-project-automation bot moved this to Needs Triage in Triage May 22, 2025
@lumirlumir lumirlumir mentioned this pull request May 22, 2025
69 tasks
@snitin315 snitin315 moved this from Needs Triage to Implementing in Triage May 22, 2025
@lumirlumir lumirlumir marked this pull request as draft May 22, 2025 08:50
@lumirlumir lumirlumir marked this pull request as ready for review May 22, 2025 10:12
@lumirlumir lumirlumir changed the title feat: add url field to existing rules feat: add url and recommended field to existing rules May 22, 2025
@mdjermanovic
Copy link
Member

I think it's fine to link to https://github.com/eslint/json#rules until we add dedicated docs.

Can you also enable eslint-plugin/require-meta-docs-url rule? Here's an example: https://github.com/eslint/markdown/blob/18c7d776c768b901a0049b6e9bd7cf9e060ae835/eslint.config.js#L107C5-L113.

@lumirlumir
Copy link
Member Author

@mdjermanovic

Thanks for the suggestions. I've added a new commit 85b1ea1

Copy link
Member

@mdjermanovic mdjermanovic 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! Leaving open for @snitin315 to verify.

@lumirlumir lumirlumir moved this from Implementing to Second Review Needed in Triage May 27, 2025
@lumirlumir lumirlumir requested a review from snitin315 May 28, 2025 11:33
@snitin315 snitin315 merged commit 14bd26b into main May 28, 2025
16 checks passed
@snitin315 snitin315 deleted the docs-add-url-field-to-existing-rules branch May 28, 2025 11:49
@github-project-automation github-project-automation bot moved this from Second Review Needed to Complete in Triage May 28, 2025
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.

3 participants