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

Deprecate and remove support for badges defined in READMEs #499

Open
bmish opened this issue Nov 5, 2023 · 0 comments
Open

Deprecate and remove support for badges defined in READMEs #499

bmish opened this issue Nov 5, 2023 · 0 comments
Labels
Milestone

Comments

@bmish
Copy link
Owner

bmish commented Nov 5, 2023

For configs without an emoji specified nor a default emoji (e.g. ✅ for recommended), we currently assume the user will define a badge in their README. I'm not a big fan of badges defined like this. They are brittle and require the user to add custom markdown in the README which can be confusing, and they are only available in READMEs currently, not rule docs (not portable).

Instead, we should suggest users to supply the badge/image markdown using the configEmoji option so that we can automatically use it in any file that the config is mentioned.

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

No branches or pull requests

1 participant