Skip to content

docs(README): improve readability #596

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 2 commits into from
Jun 1, 2022
Merged

Conversation

Belco90
Copy link
Member

@Belco90 Belco90 commented May 31, 2022

Checks

  • I have read the contributing guidelines.
  • If some rule is added/updated/removed, I've regenerated the rules list (npm run generate:rules-list)
  • If some rule meta info is changed, I've regenerated the plugin shared configs (npm run generate:configs)

Changes

Following improvements in the README:

  • Remove the "testing-library/" prefix from the rules' table, so there is more space for other data per row
  • Set code snippets to json5 format, so comments are parsed correctly
  • Fix the invalid setup example using overrides

Context

Just some small improvements to the README.

@Belco90 Belco90 added the documentation Improvements or additions to documentation label May 31, 2022
@Belco90 Belco90 requested a review from a team May 31, 2022 22:47
@Belco90 Belco90 self-assigned this May 31, 2022
@Belco90 Belco90 merged commit 3040dad into main Jun 1, 2022
@Belco90 Belco90 deleted the improve_readme_readability branch June 1, 2022 07:02
@github-actions
Copy link

🎉 This PR is included in version 5.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants