brettz9 / awesome-jsdoc Goto Github PK

I don't know if this was your initial intent, but this list should be added to the central Awesome list here. This is a good way to promote the awesome-jsdoc list (asides from putting it in your GitHub profile README of course) (note that new lists also get featured on the Awesome Twitter account as well) 👍.

To do's (for compliance with the guidelines stated here:

• Has been around for at least 30 days.
• The default branch should be named main, not master.
• 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: # Awesome Name of List.
• 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. If you really need to include such items, they should be in a separate Markdown file.
• Includes a project logo/illustration whenever possible.
• Entries have a description, unless the title is descriptive enough by itself.
• Includes the Awesome badge.
• Has a Table of Contents section.
• Has an appropriate license.
• Has contribution guidelines.
• Has consistent formatting and proper spelling/grammar.
• Doesn't use hard-wrapping.
• Doesn't include a Travis badge.
• Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme.
• Review at least 2 other open pull requests.

Seems like the list has complied with most of the requirements. Renaming the master branch to main isn't that difficult. Project logo or illustration is optional, tho I will try to make one anyway. And for the license, you should use CC0.

Once all of that is done, we are well set.

Cheers. 👍