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

add to awesome list #1

Open
12 of 14 tasks
erwanp opened this issue Sep 4, 2019 · 0 comments
Open
12 of 14 tasks

add to awesome list #1

erwanp opened this issue Sep 4, 2019 · 0 comments

Comments

@erwanp
Copy link
Owner

erwanp commented Sep 4, 2019

The list I'm submitting complies with these requirements:

  • 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.
    - Drop all the A / An prefixes in the descriptions.
    - 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.
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

1 participant