[GH-ISSUE #2097] Pull request template: badge placement rule contradicts the linter #8405

New Issue

GiteaMirror · 2026-04-19T03:12:40-05:00

GiteaMirror commented

2026-04-19 03:12:40 -05:00

Originally created by @ZoomRmc on GitHub (Nov 15, 2021).
Original GitHub issue: https://github.com/sindresorhus/awesome/issues/2097

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.

Originally created by @ZoomRmc on GitHub (Nov 15, 2021). Original GitHub issue: https://github.com/sindresorhus/awesome/issues/2097 Per [pull_request_template.md](https://github.com/sindresorhus/awesome/blob/main/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: ```markdown # <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.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/awesome-sindresorhus#8405