Skip to content

sellisd/awesomeReview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 

Repository files navigation

Automate the review process of awesome lists

Here are the requirements for a successful review. I have classified the requirements as:

  • βœ” those that I think could be relatively easy to check with a script
  • πŸ‘ those that need a careful look by a human
  • ⁇ Could possibly be automated, but I do not know the technology to do it

Requirements for a readme file in an awesome list

  • ⁇ 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.
  • πŸ‘ Includes a succinct description of the project/theme at the top of the readme. (Example)
  • πŸ‘ The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • βœ” Not a duplicate.
  • πŸ‘ Only has awesome items. Awesome lists are curations of the best, not everything.
  • βœ” Includes a project logo/illustration whenever possible.
    • ⁇ Either fullwidth or 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.
  • βœ” Includes the Awesome badge.
    • ⁇ Should be placed on the right side of the readme heading.
    • βœ” Should link back to this list.
  • βœ” Has a Table of Contents section.
    • βœ” Should be named Contents, not Table of Contents.
    • βœ” Should be the first section in the list.
    • ⁇ Should only have one level of sub-lists, preferably none.
  • ⁇ Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • WTFPL and Unlicense are not acceptable licenses.
    • ⁇ 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.
    • βœ” The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • βœ” The description starts with an uppercase character and ends with a period.
    • πŸ‘ Consistent and correct 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.

About

Automate reviewing of awesome lists

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors