Meta-list

[joshmoore]

Hi @DahnJ.

I began submitting this repo to the meta list: sindresorhus/awesome@main...joshmoore:awesome:patch-1 but the PR template had quite a long list of statements of the form "read and understand...". Happy to turn that over to you or otherwise follow your lead.

[DahnJ]

Hi @joshmoore, thanks for trying to add it in!

Talk about stringent requirements! I tried to follow some of the guidelines but got stuck at the linter that puts restrictions that I don't quite agree with, such as not including (even an internal) link twice.

I'm posting the listing results & the PR text (as the repository explicitly forbids draft PRs) here. I'm right now not sure if addition to that list is worth attempting to comply with all the requirements 🤷 Maybe I'll try again later.

linting results

README.md:123:3
  ✖    1:1    Missing Awesome badge after the main heading                              remark-lint:awesome-badge
  ✖    1:1    Git repository must be at least 30 days old                               remark-lint:awesome-git-repo-age
  ✖    1:1    Missing or invalid Table of Contents                                      remark-lint:awesome-toc
  ✖    7:1    https://zarr.dev/                                                         remark-lint:double-link
  ✖   10:1    Don’t use multiple top level headings (1:1)                               remark-lint:no-multiple-toplevel-headings
  ✖   10:1    List can only have one heading                                            remark-lint:awesome-heading
  ✖   12:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   13:3    #introductory-videos                                                      remark-lint:double-link
  ✖   13:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   14:3    #zarr-v3                                                                  remark-lint:double-link
  ✖   14:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   15:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   16:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   17:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   18:3    #talks--videos                                                            remark-lint:double-link
  ✖   18:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   19:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   22:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   23:3    #geozarr                                                                  remark-lint:double-link
  ✖   23:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   24:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖   27:1    Don’t use multiple top level headings (1:1)                               remark-lint:no-multiple-toplevel-headings
  ✖   27:1    List can only have one heading                                            remark-lint:awesome-heading
  ✖   30:5    https://zarr.dev/                                                         remark-lint:double-link
  ✖   37:52   https://zarr.dev/implementations/                                         remark-lint:double-link
  ✖   37:156  https://zarr.dev/conventions/                                             remark-lint:double-link
  ✖   41:28   #talks--videos                                                            remark-lint:double-link
  ✖   44:1    https://www.youtube.com/playlist?list=PLvkeNUPrCU04Xvcph4ErxsRkZq28Oucr7  remark-lint:double-link
  ✖   44:2    Text "Youtube" should be written as "YouTube"                             remark-lint:awesome-spell-check
  ✖   51:1    https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html             remark-lint:double-link
  ✖   64:34   https://zarr.dev/implementations/                                         remark-lint:double-link
  ✖   65:3    https://fsspec.github.io/kerchunk/                                        remark-lint:double-link
  ✖   65:49   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   65:55   #kerchunk                                                                 remark-lint:double-link
  ✖   66:61   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   69:55   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   72:55   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   73:48   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   74:56   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   75:60   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   78:3    https://docs.xarray.dev/en/stable/index.html                              remark-lint:double-link
  ✖   78:57   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   80:56   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   80:73   https://docs.xarray.dev/en/stable/index.html                              remark-lint:double-link
  ✖   81:44   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   85:60   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   86:68   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   87:61   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   88:58   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   89:52   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖   94:1    https://fsspec.github.io/kerchunk/                                        remark-lint:double-link
  ✖  102:74   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  107:3    https://docs.earthmover.io/                                               remark-lint:double-link
  ✖  107:43   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  112:63   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  116:75   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  117:7    https://www.youtube.com/playlist?list=PLvkeNUPrCU04Xvcph4ErxsRkZq28Oucr7  remark-lint:double-link
  ✖  120:3    #introductory-videos                                                      remark-lint:double-link
  ✖  120:3    Invalid list item link URL                                                remark-lint:awesome-list-item
  ✖  123:3    Don’t pad link with inner spaces                                          remark-lint:no-inline-padding
  ✖  123:128  List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  125:69   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  132:41   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  133:52   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  134:51   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  135:53   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  145:40   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  146:39   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  147:47   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  148:57   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  151:1    Don’t use multiple top level headings (1:1)                               remark-lint:no-multiple-toplevel-headings
  ✖  151:1    List can only have one heading                                            remark-lint:awesome-heading
  ✖  156:77   #kerchunk                                                                 remark-lint:double-link
  ✖  162:37   https://docs.xarray.dev/en/stable/index.html                              remark-lint:double-link
  ✖  164:71   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  167:114  List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  179:140  https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html             remark-lint:double-link
  ✖  184:45   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  190:23   https://zarr.dev/conventions/                                             remark-lint:double-link
  ✖  208:76   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  217:3    https://docs.earthmover.io/                                               remark-lint:double-link
  ✖  217:43   List item link and description must be separated with a dash              remark-lint:awesome-list-item
  ✖  219:20   #zarr-v3                                                                  remark-lint:double-link
  ✖  219:49   #geozarr                                                                  remark-lint:double-link

PR draft

https://github.com/DahnJ/Awesome-Zarr

The list is about Zarr, a cloud-native, chunked, compressed, and hierarchical array data format.

Requirements for your pull request

• Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
• Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
• You have to review at least 2 other open pull requests.
  Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions. Comments pointing out lint violation are allowed, but does not count as a review.
• You have read and understood the instructions for creating a list.
• This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
  • ✅ Add Swift
  • ✅ Add Software Architecture
  • ❌ Update readme.md
  • ❌ Add Awesome Swift
  • ❌ Add swift
  • ❌ add Swift
  • ❌ Adding Swift
  • ❌ Added Swift
• Your entry here should include a short description of the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb. It should not contain the name of the list.
  • ✅ - [iOS](…) - Mobile operating system for Apple phones and tablets.
  • ✅ - [Framer](…) - Prototyping interactive UI designs.
  • ❌ - [iOS](…) - Resources and tools for iOS development.
  • ❌ - [Framer](…)
  • ❌ - [Framer](…) - prototyping interactive UI designs
• Your entry should be added at the bottom of the appropriate category.
• The title of your entry should be title-cased and the URL to your list should end in #readme.
  • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
• No blockchain-related lists.
• The suggested Awesome list complies with the below requirements.

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 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.
• The default branch should be named main, not master.
• 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.
• The repo name of your list should be in lowercase slug format: awesome-name-of-list.
  • ✅ awesome-swift
  • ✅ awesome-web-typography
  • ❌ awesome-Swift
  • ❌ AwesomeWebTypography
• The heading title of your list should be in title case format: # Awesome Name of List.
  • ✅ # Awesome Swift
  • ✅ # Awesome Web Typography
  • ❌ # awesome-swift
  • ❌ # AwesomeSwift
• Non-generated Markdown file in a GitHub repo.
• The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant 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. 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 a maximum of half the width of the original image.
  • Don't include both a title saying Awesome X and a logo with Awesome X. You can put the header image in a # (Markdown header) or <h1>.
• 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.
    • 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.
  • Must not feature Contributing or Footnotes sections.
• 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=main&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, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text 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.
• Has contribution guidelines.
  • The file should be named contributing.md. The casing is up to you.
  • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
  • The section should not appear in the Table of Contents.
• All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
• 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.
• Does not use hard-wrapping.
• Does not include a CI (e.g. GitHub Actions) badge.
  You can still use a CI for linting, but the badge has no value in the readme.
• Does not 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.

Go to the top and read it again.