Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Match current standards for awesome-lists as defined by @sindresorhus #105

Open
20 of 26 tasks
RichardLitt opened this issue Apr 16, 2017 · 1 comment
Open
20 of 26 tasks

Match current standards for awesome-lists as defined by @sindresorhus #105

RichardLitt opened this issue Apr 16, 2017 · 1 comment
Labels
help wanted

Comments

@RichardLitt
Copy link
Owner

RichardLitt commented Apr 16, 2017 •
edited
Loading

@sindresorhus has changed the standards for an awesome-list, and this list needs to be changed to match. See sindresorhus/awesome#926 for more.

Criteria

  • 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.
  • It's the result of hard work and the best I could possibly produce.
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have the following GitHub topics set: awesome-list, awesome, list. I encourage you to add more relevant topics.
  • Not a duplicate.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Includes a project logo/illustration whenever possible.
    • 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.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Has the Awesome badge on the right side of the list heading,
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
  • Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • If you use a license badge, it should be SVG, not PNG.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
  • Has consistent formatting and proper spelling/grammar.
    • Each link description starts with an uppercase character and ends with a period.
      Example: - [AVA](…) - JavaScript test runner.
    • Drop all the A / An prefixes in the descriptions.
    • Consistent naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
RichardLitt added a commit that referenced this issue Apr 16, 2017
@RichardLitt
Rename
bab9add 
See #105
RichardLitt added a commit that referenced this issue Apr 17, 2017
@RichardLitt
Overhaul
fdeb954 
See #105
RichardLitt added a commit that referenced this issue Apr 17, 2017
@RichardLitt
Overhaul the list to make it better (#94)
91aad38 
* Overhaul list

The list needs an overhaul, badly. The conferences as they are aren't actually all the useful to anyone - some of these links are broken, some are old, and there's no general information on registration or CFPs. I've gone three and added a template and converted three as an example. I think that editing them and having a much fuller list would be good, for everyone.

Can others tell me if this looks like the right idea? Would you be keen on helping out?

Relevant to #3, #23, #34, #67, #69.

* Move past conferences, add videos, notes, and roundups

* add DEVit conference (#98)

* Added npmCamp and new lines where appropriate 🎉 (#99)

Thought it was odd that there weren’t any new lines in the conference sections when there were new lines in every other section so I just added them. Also deleted last line.

I wanted to add npmCamp because I had such a great time as a diversity scholarship recipient. And since it’s marketed as a community conference focused on all things npm, I figured it deserved **awesome** recognition.

Signed-off-by: FVCproductions <[email protected]>

* add React Amsterdam and AmsterdamJS (#100)

* Update broken links (#101)

* adds active indgredients (#102)

* adds active indgredients

* Update README.md

* Add RigaDevDays to the list (#103)

* Add RigaDevDays to the list

* alphabetize

* add DevTernity conference (#104)

* Rename

See #105

* Overhaul list

The list needs an overhaul, badly. The conferences as they are aren't actually all the useful to anyone - some of these links are broken, some are old, and there's no general information on registration or CFPs. I've gone three and added a template and converted three as an example. I think that editing them and having a much fuller list would be good, for everyone.

Can others tell me if this looks like the right idea? Would you be keen on helping out?

Relevant to #3, #23, #34, #67, #69.

* Move past conferences, add videos, notes, and roundups

* Overhaul

See #105
@RichardLitt
Copy link
Owner Author

All of the easy stuff is done; what is left now is to go through each item and conform it to the new template, and make it look beautiful.

@RichardLitt RichardLitt mentioned this issue Apr 17, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@RichardLitt