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

Output isn't compatible with awesome-lint #179

Open
morinted opened this issue Apr 10, 2021 · 1 comment
Open

Output isn't compatible with awesome-lint #179

morinted opened this issue Apr 10, 2021 · 1 comment

Comments

@morinted
Copy link

morinted commented Apr 10, 2021

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?

@dar5hak
Copy link
Owner

dar5hak commented Apr 14, 2021

Hi @morinted! Thanks for pointing these out. I'm definitely interested in these changes; just haven't kept up with awesome-lint of late.

Go ahead with a PR if you want to, that'd be great. And feel free to ask any questions. If you cannot, I'll get around to doing these in a weekend or two.

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

No branches or pull requests

2 participants