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

Match current standards for awesome-lists as defined by @sindresorhus #36

Open
19 of 26 tasks
RichardLitt opened this issue Apr 16, 2017 · 0 comments
Open
19 of 26 tasks

Comments

@RichardLitt
Copy link
Owner

RichardLitt commented Apr 16, 2017

@sindresorhus has changed the standards for an awesome-list, and this list needs to be changed to match. See sindresorhus/awesome#926 for more.

Criteria

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • It's the result of hard work and the best I could possibly produce.
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have the following GitHub topics set: awesome-list, awesome, list. I encourage you to add more relevant topics.
  • Not a duplicate.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Includes a project logo/illustration whenever possible.
    • Placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Has the Awesome badge on the right side of the list heading,
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
  • Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • If you use a license badge, it should be SVG, not PNG.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
  • Has consistent formatting and proper spelling/grammar.
    • Each link description starts with an uppercase character and ends with a period.
      Example: - [AVA](…) - JavaScript test runner.
    • Drop all the A / An prefixes in the descriptions.
    • Consistent naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
RichardLitt added a commit that referenced this issue Apr 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant