Skip to content

Submit the list to sindresorhus/awesome #102

Description

@AnayDhawan

Submission itself is a maintainer task, since the PR has to come from the project owner. The conformance work below is fully open for contribution and is the part that actually takes effort.

Goal

Get this list accepted into sindresorhus/awesome. The checklist there is strict and most PRs are closed within minutes for avoidable formatting problems.

Contributor part: make the list conformant

Work through the awesome list requirements and fix every deviation:

  • awesome-lint passes with zero errors (tracked in Run awesome-lint in CI #103, do that one first)
  • README has the awesome badge
  • Description does not start with "A list of" and carries no marketing language
  • Table of contents sits directly after the description
  • Every entry has a description that starts with a capital letter and ends with a full stop
  • Entry format is [Name](link) - Description. exactly, including the hyphen spacing
  • License file present. CC0 is preferred over MIT for a content list
  • Repository has a short GitHub description and topics set

How to check your work

npx awesome-lint

Fix everything it reports. Then read three or four recently closed PRs on sindresorhus/awesome to see what reviewers actually reject, and check this list against those reasons too.

Notes

The entry description rule is the one that bites hardest here, since it applies to every single line in the list. Expect that to be the bulk of the work.

Scope: medium, roughly 2 hours, mostly mechanical. Depends on #103.

New here? See CONTRIBUTING.md.

Metadata

Metadata

Assignees

No one assigned

    Labels

    growthDistribution and tractionhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions