From bfd49b53a51bb97184be3a69240566a1738128a3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 9 Jul 2020 23:41:55 +0000 Subject: [PATCH] Fully ahere to the awesome list guidelines --- README.md | 61 +++++++++++++++++++++++++++++++++++++++-- developers.yaml | 73 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 131 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d52c6f4..b2b42ee 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ > Talks, blog posts, and interviews amplifying the voices of Black developers on GitHub because #BlackLivesMatter -[@aprilspeight](aprilspeight) | [@bdougie](bdougie) | [@dayhaysoos](dayhaysoos) | [@ifiokjr](ifiokjr) | [@m0nica](m0nica) | [@Prophen](Prophen) | [@kjaymiller](kjaymiller) ---- | --- | --- | --- | --- | --- | --- -![@aprilspeight](https://avatars.githubusercontent.com/aprilspeight?s=100&v=1) | ![@bdougie](https://avatars.githubusercontent.com/bdougie?s=100&v=1) | ![@dayhaysoos](https://avatars.githubusercontent.com/dayhaysoos?s=100&v=1) | ![@ifiokjr](https://avatars.githubusercontent.com/ifiokjr?s=100&v=1) | ![@m0nica](https://avatars.githubusercontent.com/m0nica?s=100&v=1) | ![@Prophen](https://avatars.githubusercontent.com/Prophen?s=100&v=1) | ![@kjaymiller](https://avatars.githubusercontent.com/kjaymiller?s=100&v=1) +[@aprilspeight](#aprilspeight) | [@bdougie](#bdougie) | [@dayhaysoos](#dayhaysoos) | [@ifiokjr](#ifiokjr) | [@m0nica](#m0nica) | [@Prophen](#Prophen) | [@kjaymiller](#kjaymiller) | [@Requirements for your Awesome list](#Requirements for your Awesome list) +--- | --- | --- | --- | --- | --- | --- | --- +![@aprilspeight](https://avatars.githubusercontent.com/aprilspeight?s=100&v=1) | ![@bdougie](https://avatars.githubusercontent.com/bdougie?s=100&v=1) | ![@dayhaysoos](https://avatars.githubusercontent.com/dayhaysoos?s=100&v=1) | ![@ifiokjr](https://avatars.githubusercontent.com/ifiokjr?s=100&v=1) | ![@m0nica](https://avatars.githubusercontent.com/m0nica?s=100&v=1) | ![@Prophen](https://avatars.githubusercontent.com/Prophen?s=100&v=1) | ![@kjaymiller](https://avatars.githubusercontent.com/kjaymiller?s=100&v=1) | ![@Requirements for your Awesome list](https://avatars.githubusercontent.com/Requirements for your Awesome list?s=100&v=1) ### [@aprilspeight](https://github.com/aprilspeight) @@ -36,6 +36,61 @@ * Productivity in Tech ([project](https://productivityintech.com/)) * PIT Reflection: GitHub Sponsors, Talking to Mentors, and Writing Docs ([podcast](https://productivityintech.transistor.fm/s2020/10)) +### [@Requirements for your Awesome list](https://github.com/Requirements for your 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. + * - [ ] Run [](https://github.com/sindresorhus/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](https://github.com/sindresorhus/awesome-lint/issues/new). + * - [x] The default branch should be named [, not ](https://www.zdnet.com/article/github-to-replace-master-with-alternative-term-to-avoid-slavery-references/). + * - [x] Includes a succinct description of the project/theme at the top of the readme. [(Example)](https://github.com/willempienaar/awesome-quantified-self) + * - ✅ + * - ✅ + * - ❌ + * - ❌ + * -[ ] 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: . + * - ✅ + * - ✅ + * - ❌ + * - ❌ + * - [x] The heading title of your list should be in [title case](https://capitalizemytitle.com/) format: . + * - ✅ + * - ✅ + * - ❌ + * - ❌ + * - [ ] Non-generated Markdown file in a GitHub repo. + * - [x] The repo should have & as [GitHub topics](https://help.github.com/articles/about-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)](https://github.com/sindresorhus/awesome-electron) + * - 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](awesome.md#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 , not . + * - Should be the first section in the list. + * - Should only have one level of [nested lists](https://commonmark.org/help/tutorial/10-nestedLists.html), preferably none. + * - [x] Has an appropriate license. + * - We strongly recommend the [CC0 license](https://creativecommons.org/publicdomain/zero/1.0/), but any [Creative Commons license](https://creativecommons.org/choose/) will work. + * - Tip: You can quickly add it to your repo by going to this URL: (replace and accordingly). + * - A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and [Unlicense](https://unlicense.org). + * - Place a file named or 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 . + * - [x] Has [contribution guidelines](awesome.md#include-contribution-guidelines). + * - The file should be named . Casing is up to you. + * - [x] Has consistent formatting and proper spelling/grammar. + * - The link and description are separated by a dash.
Example: + * - The description starts with an uppercase character and ends with a period. + * - Consistent and correct naming. For example, , not or . + * - [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 or kinda link at the top of the readme. The Awesome badge is enough. + ## 💅🏾 Contributing Additional suggestions are welcomed! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. diff --git a/developers.yaml b/developers.yaml index b47445e..986fe13 100644 --- a/developers.yaml +++ b/developers.yaml @@ -21,3 +21,76 @@ Prophen: kjaymiller: - Productivity in Tech ([project](https://productivityintech.com/)) - 'PIT Reflection: GitHub Sponsors, Talking to Mentors, and Writing Docs ([podcast](https://productivityintech.transistor.fm/s2020/10))' +Requirements for your 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." +- "- [ ] Run [](https://github.com/sindresorhus/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](https://github.com/sindresorhus/awesome-lint/issues/new)." +- "- [x] The default branch should be named [, not ](https://www.zdnet.com/article/github-to-replace-master-with-alternative-term-to-avoid-slavery-references/)." +- "- [x] Includes a succinct description of the project/theme at the top of the readme. + [(Example)](https://github.com/willempienaar/awesome-quantified-self)" +- "- ✅" +- "- ✅" +- "- ❌" +- "- ❌" +- "-[ ] 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: ." +- "- ✅" +- "- ✅" +- "- ❌" +- "- ❌" +- "- [x] The heading title of your list should be in [title case](https://capitalizemytitle.com/) + format: ." +- "- ✅" +- "- ✅" +- "- ❌" +- "- ❌" +- "- [ ] Non-generated Markdown file in a GitHub repo." +- "- [x] The repo should have & as [GitHub topics](https://help.github.com/articles/about-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)](https://github.com/sindresorhus/awesome-electron)" +- "- 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](awesome.md#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 , not ." +- "- Should be the first section in the list." +- "- Should only have one level of [nested lists](https://commonmark.org/help/tutorial/10-nestedLists.html), + preferably none." +- "- [x] Has an appropriate license." +- "- We strongly recommend the [CC0 license](https://creativecommons.org/publicdomain/zero/1.0/), + but any [Creative Commons license](https://creativecommons.org/choose/) will work." +- "- Tip: You can quickly add it to your repo by going to this URL: (replace and + \ accordingly)." +- "- A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are + WTFPL and [Unlicense](https://unlicense.org)." +- "- Place a file named or 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 ." +- "- [x] Has [contribution guidelines](awesome.md#include-contribution-guidelines)." +- "- The file should be named . Casing is up to you." +- "- [x] Has consistent formatting and proper spelling/grammar." +- "- The link and description are separated by a dash.
Example:" +- "- The description starts with an uppercase character and ends with a period." +- "- Consistent and correct naming. For example, , not or ." +- "- [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 or kinda link at the top of the readme. The Awesome + badge is enough."