bdougie / awesome-black-developers

Amplifying the voices of Black developers in open source because #BlackLivesMatter ✊🏾
Creative Commons Zero v1.0 Universal
233 stars 23 forks source link

Fully ahere to the awesome list guidelines #9

Open bdougie opened 4 years ago

bdougie commented 4 years ago

Requirements for your Awesome list

Cybersoulja commented 1 year ago

Requirements for your Awesome list

  • [x] 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.
  • [ ] Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • [x] The default branch should be named main, not master.
  • [x] Includes a succinct description of the project/theme at the top of the readme. (Example)

    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools. -[ ] It's the result of hard work and the best I could possibly produce. If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • [x] The repo name of your list should be in lowercase slug format: awesome-name-of-list.

    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • [x] The heading title of your list should be in title case format: # Awesome Name of List.

    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • [x] Non-generated Markdown file in a GitHub repo.
  • [x] The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • [x] Not a duplicate. Please search for existing submissions.
  • [x] Only has awesome items. Awesome lists are curations of the best, not everything.
  • [x] Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • [ ] Includes a project logo/illustration whenever possible.

    • Either centered, 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.
  • [x] Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • [x] Includes the Awesome badge.

    • Should be placed on the right side of the readme heading.

    • Can be placed centered if the list has a centered graphics header.

    • 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 nested lists, preferably none.
  • [x] Has an appropriate license.

    • We strongly recommend the CC0 license, but any Creative Commons license will work.

    • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=master&template=cc0-1.0 (replace <user> and <repo> accordingly).

    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.

    • Place a file named license or LICENSE in the repo root with the license text.

    • Do not add the license name or text to the readme. GitHub already shows the license name at the top of the repo.

    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.

  • [x] Has contribution guidelines.

    • The file should be named contributing.md. Casing is up to you.
  • [x] 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.
  • [x] Doesn't include a Travis badge.You can still use Travis for list linting, but the badge has no value in the readme.
  • [x] Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Thank you