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

Pull request template: badge placement rule contradicts the linter #2097

Open
ZoomRmc opened this issue Nov 15, 2021 · 0 comments
Open

Pull request template: badge placement rule contradicts the linter #2097

ZoomRmc opened this issue Nov 15, 2021 · 0 comments

Comments

@ZoomRmc
Copy link

ZoomRmc commented Nov 15, 2021

Per pull_request_template.md:

Awesome badge... Should be placed on the right side of the readme heading.

However, if the header includes the badge, the linter fails with the following error:
✖ 1:1 Missing Awesome badge after the main heading remark-lint:awesome-badge

Failing example markdown source for the header:

# <a href="https://nim-lang.org"><img src="https://raw.githubusercontent.com/indiscipline/awesome-nim/logo/asset/awesome-nim-logo.svg" alt="Awesome-nim-logo" width="600"/></a><a href="https://awesome.re"><img align="right" src="https://awesome.re/badge.svg"></a>

Also, in #1997 @sindresorhus mentions "Don't have both the image header and the text header."
This is not included in the guidelines. The wording of the point The heading title of your list should be in title case implies there has to be a text header, which is a contradiction.

Repository owner locked and limited conversation to collaborators May 27, 2024
Repository owner deleted a comment from Venkatareddy7709 May 27, 2024
Repository owner deleted a comment from syedhassansamin May 27, 2024
Repository owner deleted a comment from Anisa-Infinitesoul May 27, 2024
Repository owner deleted a comment from Longdo2003200 May 27, 2024
Repository owner deleted a comment from Tazdaddy1 May 27, 2024
Repository owner deleted a comment from Kesh01 May 27, 2024
Repository owner deleted a comment from Mz1111LKT May 27, 2024
Repository owner deleted a comment from Muzmilking May 27, 2024
Repository owner deleted a comment from peh3k May 27, 2024
Repository owner deleted a comment from Drew3040 May 27, 2024
Repository owner deleted a comment from peh3k May 27, 2024
Repository owner deleted a comment from AnfalBani May 27, 2024
Repository owner deleted a comment from jeril-jonson May 27, 2024
Repository owner deleted a comment from ahmedjanwar May 27, 2024
Repository owner deleted a comment from TalleA15 May 27, 2024
Repository owner deleted a comment from NasirAlbani May 27, 2024
Repository owner deleted a comment from HOP01 May 27, 2024
Repository owner deleted a comment from sojibur671 May 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

10 participants
@ZoomRmc and others