Skip to content

Outstanding requirements #12

Description

@nkrusch

Ref: list guidelines

Checklist of requirements for your awesome list

  • Has been around for at least 30 days from when it was open-sourced.
  • Run awesome-lint on your list and fix the reported issues.
  • The default branch should be named main
  • Includes a succinct description of the project/theme at the top of the readme.
  • It's the result of hard work and the best I could possibly produce.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
  • The heading title of your list should be in title case format.
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme.
    • The image should be high-DPI and set to a maximum of half the width of the original image.
    • The image should link to the project website or any relevant website.
    • Don't include both a title saying Awesome X and a logo with Awesome X.
  • Entries have a description, unless the title is descriptive enough by itself.
  • Includes the Awesome badge.
  • Has a TOC (named "Contents", first list section, one level, no Contributing or Footnotes)
  • Has an appropriate license.
  • Has contribution guidelines.
  • All non-important but necessary content is in footnotes section.
  • Has consistent formatting and proper spelling/grammar.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
  • Does not include an "Inspired by awesome-foo" kinda link at the top of the readme.

Additionally:

  • 4x PR review requirement

Some implicit/implied requirements:

  • Descriptions must be 1 sentence (not too verbose)
  • Sections cannot be "too thin" - if a section has 1-2 items, it should be merged.
  • No undisclosed self-promotion (list includes link to owner's project)
  • CTAs or marketing jargon type text is not allowed

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions