Skip to content

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

@ZoomRmc

Description

@ZoomRmc

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions