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: Explicitly mention flat config for findability #190

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

Sidnioulz
Copy link
Member

No linked issue.

What Changed

This PR adds an explicit mention of "flat config" in the flat config section.

Why?

I often search for 'flat config' when taking over a project and having to decide if it's ready to upgrade to ESLint 9. When I looked at this plugin today, I parsed the README quickly and initially missed the flat config section. I had to check the dependencies to see that it supports ESLint 9.

Many major ESLint plugins use the word flat somewhere in their description of this new config:

The ones that don't:

Using the explicit wording in the relevant section ensures a ^+F search finds a match, since not finding anything when searching for "flat" could lead users to wrongly assume that ESLint 9 is not supported.

Checklist

Check the ones applicable to your change:

  • Ran pnpm run update-all
  • Tests are updated
  • Documentation is updated

Change Type

Indicate the type of change your pull request is:

  • maintenance
  • documentation
  • patch
  • minor
  • major

@kasperpeulen kasperpeulen added the documentation Changes only affect the documentation label Feb 12, 2025
@kasperpeulen kasperpeulen merged commit a515019 into main Feb 12, 2025
0 of 2 checks passed
@kasperpeulen kasperpeulen deleted the docs/readme-flat-config-mention branch February 12, 2025 12:34
Copy link

🚀 PR was released in v0.11.3 🚀

@github-actions github-actions bot added the released This issue/pull request has been released. label Feb 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants