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: Clearly mark rules that are frozen #18694

Open
1 task
nzakas opened this issue Jul 16, 2024 · 5 comments
Open
1 task

Docs: Clearly mark rules that are frozen #18694

nzakas opened this issue Jul 16, 2024 · 5 comments
Assignees
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation

Comments

@nzakas
Copy link
Member

nzakas commented Jul 16, 2024

Docs page(s)

https://eslint.org/docs/latest/rules/

And each individual rule page

What documentation issue do you want to solve?

While we say that stylistic rules are frozen, we don't clearly indicate which rules are frozen.

What do you think is the correct solution?

We should clearly mark rules that are frozen with ❄️ in the place of the green checkbox on the rules index page.

We should also add a notice to the top of each rule page that is frozen, in the same style as "recommended", that says. "This rule is currently frozen and is not accepting changes."

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

@nzakas nzakas added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Jul 16, 2024
@kirkwaiblinger
Copy link
Contributor

At typescript-eslint we've had success in turning down feature requests with no hard feelings due to similar notices.
Just mentioning in case it's helpful as an example, see typescript-eslint/typescript-eslint#9554, https://typescript-eslint.io/rules/naming-convention/.

@amareshsm
Copy link
Member

I would like to work on this. Assigning it to myself.

@amareshsm amareshsm self-assigned this Jul 16, 2024
@nzakas
Copy link
Member Author

nzakas commented Jul 17, 2024

@amareshsm thanks!

@mdjermanovic
Copy link
Member

Where shall we maintain info about which rules are frozen? Maybe in meta.docs.frozen property (boolean) of rules?

@amareshsm
Copy link
Member

Where shall we maintain info about which rules are frozen? Maybe in meta.docs.frozen property (boolean) of rules?

Yes, I was thinking the same. In the meta.docs.frozen section, we can specify whether the rule is frozen or not.

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: Ready to Implement
Development

No branches or pull requests

4 participants