Skip to content

Output isn't compatible with awesome-lint #179

@panathea

Description

@panathea

I used this generator as a starting point for an awesome list, but I found its output to be incompatible with the recommended https://github.com/sindresorhus/awesome-lint

Here are some extra steps beyond the generator that I had to implement for my awesome-"thing" list in order for it to meet the guidelines:

  • Rename "Contribute" heading to "Contributing".
  • Add a LICENSE (CC0 is recommended by awesome).
  • A description of the "thing" under the description of the list. I.e. Title\n\n> Description of list.\n\nDescription of thing.
  • A logo or image, linked to the website of the thing.
  • Add awesome-lint to the GitHub actions workflow.
  • My most "iffy" change, adding some more specific guidelines on how to contribute to an awesome list, including encouraging reviewing open PRs and mentioning the syntax requirements.

I would be interested in making a PR to add one or all of these features, is this something that you'd like to see?

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