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

Change Request: Create new page for adding core rules #16648

Closed
1 task done
Tracked by #16365
bpmutter opened this issue Dec 11, 2022 · 0 comments · Fixed by #16797
Closed
1 task done
Tracked by #16365

Change Request: Create new page for adding core rules #16648

bpmutter opened this issue Dec 11, 2022 · 0 comments · Fixed by #16797
Assignees
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects

Comments

@bpmutter
Copy link
Contributor

bpmutter commented Dec 11, 2022

ESLint version

latest

What problem do you want to solve?

From eslint/rfcs#97 (comment):

The content of this page covers both custom rules and core (built-in) rules. Writing a custom rule and a core rule is basically the same. The page also includes some conventions we're using in core rules. I'm not sure where in the new hierarchy this page should be, and what its title should be, as it is of interest to both Extenders and Community Contributors.

What do you think is the correct solution?

From eslint/rfcs#97 (comment):

  1. keep the majority of the rule creation content on the "Custom Rules" page in the Extender documentation section. remove content about creating core rules. note somewhere on this page that if you want to create a core rule, refer to the Core Rules documentation (expanded on in next point).
  2. create a new "Core Rules" page in the Contributor documentation section. extract all content specifically about creating core rules into this page. This page should, as Nicholas proposed, point to the "Custom Rules" page for most of the rule creation documentation.
  3. do this work as a fast follow to the initial IA migration. while there could certainly be some confusion about how to work on custom rules between the initial migration and the completion of this work, i don't think it'd be a significant issue for the following reasons:
  • i don't think many people are working on core rules at a given moment
  • those people can probably figure out what they need to from the custom rules documentation.
  • if those people run into any issues, they can ask in the Discord, and we can point them in the right direction.
  • the amount of time when this is a potential issue would be pretty short, especially if we prioritize the reviews
on the content splitting the pages, so that the changes get moved promptly.

Participation

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

Additional comments

No response

@bpmutter bpmutter added core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Dec 11, 2022
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Dec 11, 2022
@mdjermanovic mdjermanovic moved this from Needs Triage to Ready to Implement in Triage Dec 11, 2022
@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon core Relates to ESLint's core APIs and features labels Dec 11, 2022
bpmutter added a commit to bpmutter/eslint that referenced this issue Jan 19, 2023
bpmutter added a commit to bpmutter/eslint that referenced this issue Jan 21, 2023
bpmutter added a commit to bpmutter/eslint that referenced this issue Jan 28, 2023
mdjermanovic added a commit that referenced this issue Feb 9, 2023
* docs: split rule docs

Resolves #16648

* Add todo

* add page to IA

* Copy edits + remove TODO

* Update docs/src/contribute/contribute-core-rule.md

Co-authored-by: Nitin Kumar <snitin315@gmail.com>

* Apply suggestions from code review

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* Apply suggestions from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* move rule performance testing to custom rules

* Apply suggestions from code review

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* add basic custom rule overview

---------

Co-authored-by: Nitin Kumar <snitin315@gmail.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Aug 9, 2023
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Aug 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
Archived in project
Triage
Ready to Implement
Development

Successfully merging a pull request may close this issue.

2 participants