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.

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

Add lit-html #1357

Merged
merged 2 commits into from Sep 18, 2018
Merged

Add lit-html #1357

merged 2 commits into from Sep 18, 2018

Conversation

web-padawan
Copy link
Contributor

@web-padawan web-padawan commented Jul 20, 2018

https://github.com/web-padawan/awesome-lit-html#readme

A curated list of awesome lit-html resources. lit-html — an efficient, expressive, extensible HTML templating library for JavaScript.

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • I have read and understood the contribution guidelines and the instructions for creating a list.
  • This pull request has a descriptive title.
    For example, Add Name of List, not Update readme.md or Add awesome list.
  • The entry in the Awesome list should:
    • Include a short description about the project/theme of the list. It should not describe the list itself.
      Example: - [Fish](…) - User-friendly shell., not - [Fish](…) - Resources for Fish..
    • Be added at the bottom of the appropriate category.
  • The list I'm submitting complies with these 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.
  • It's the result of hard work and the best I could possibly produce.
  • Non-generated Markdown file in a GitHub repo.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Includes a project logo/illustration whenever possible.
    • Either 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 maximum half the width of the original image.
  • 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.
    • 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 sub-lists, preferably none.
  • Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • WTFPL and Unlicense are not acceptable licenses.
    • 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.
    • 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.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.

Go to the top and read it again.


This change is Reviewable

@thepassle
Copy link

I think need to add some descriptions for the items in Implementations, Components and Starter Templates.

I'll see if i have some time tonight to add some descriptions for the items. @web-padawan

@thepassle
Copy link

thepassle commented Jul 24, 2018

@sindresorhus This one should be good to go, i reviewed according all the guidelines and made changes/additions where needed, you can see changes here web-padawan/awesome-lit#3

@sindresorhus
Copy link
Owner

@thepassle You didn't follow the specified format:

The link and description are separated by a dash.
Example: - [AVA](…) - JavaScript test runner.

@sindresorhus
Copy link
Owner

lit-html in lit-html — an efficient, expressive, extensible HTML templating library for JavaScript. should link to its website.

@sindresorhus
Copy link
Owner

If you use a license badge, it should be SVG, not PNG.

⬆️

@thepassle
Copy link

thepassle commented Jul 29, 2018

Fixed here: web-padawan/awesome-lit#4

Paging @web-padawan

@sindresorhus fix has been merged

@web-padawan
Copy link
Contributor Author

@sindresorhus thanks for the feedback! The repo is now updated, thanks for @thepassle for his great work. There is no "official" logo yet, but hopefully it should not block merging this PR.

Copy link
Contributor

@transitive-bullshit transitive-bullshit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fails awesome-lint. Please go back and make sure you're following all of the suggested guidelines.

The most frequent issue you have is that your list item descriptions need to start with proper casing (generally an upper-case letter).

  ✖   1:1    License section must be at heading depth 2                    awesome/license
  ✖   9:1    ToC missing item for "Other awesome resources"                awesome/toc
  ✖  30:59   List item link and description must be separated with a dash  awesome/list-item
  ✖  30:71   Remove trailing slash (https://polymer-slack.herokuapp.com)   no-url-trailing-slash
  ✖  36:65   List item description must start with valid casing            awesome/list-item
  ✖  37:47   List item description must start with valid casing            awesome/list-item
  ✖  38:56   List item description must start with valid casing            awesome/list-item
  ✖  39:62   List item description must start with valid casing            awesome/list-item
  ✖  40:50   List item description must start with valid casing            awesome/list-item
  ✖  41:68   List item description must start with valid casing            awesome/list-item
  ✖  42:69   List item description must start with valid casing            awesome/list-item
  ✖  43:67   List item description must start with valid casing            awesome/list-item
  ✖  44:68   List item description must start with valid casing            awesome/list-item
  ✖  45:85   List item description must start with valid casing            awesome/list-item
  ✖  46:58   List item description must start with valid casing            awesome/list-item
  ✖  50:103  List item description must start with valid casing            awesome/list-item
  ✖  51:62   List item description must start with valid casing            awesome/list-item
  ✖  55:64   List item description must start with valid casing            awesome/list-item
  ✖  56:64   List item description must start with valid casing            awesome/list-item
  ✖  60:69   List item description must start with valid casing            awesome/list-item
  ✖  61:90   List item description must start with valid casing            awesome/list-item
  ✖  66:110  List item description must start with valid casing            awesome/list-item
  ✖  67:103  List item description must start with valid casing            awesome/list-item
  ✖  68:55   List item description must start with valid casing            awesome/list-item
  ✖  69:73   List item description must start with valid casing            awesome/list-item
  ✖  70:50   List item description must start with valid casing            awesome/list-item
  ✖  82:188  List item link and description must be separated with a dash  awesome/list-item
  ✖  96:48   List item description must start with valid casing            awesome/list-item

@web-padawan
Copy link
Contributor Author

web-padawan commented Jul 31, 2018

Updated the repo to fix awesome-lint issues, also updated to use proper awesome badge.

@web-padawan
Copy link
Contributor Author

A gentle ping to @sindresorhus regarding this PR.

Please note that I have reviewed #1393 and #1395 today, to satisfy the code review requirement.

@sindresorhus sindresorhus merged commit 137dee5 into sindresorhus:master Sep 18, 2018
@sindresorhus
Copy link
Owner

web-padawan added a commit to web-padawan/lit that referenced this pull request Oct 4, 2018
The awesome list for lit-html has been merged in sindresorhus/awesome#1357 
Please consider adding this badge, so as we could help more people with blog posts, tools etc.
web-padawan added a commit to web-padawan/lit-element that referenced this pull request Oct 4, 2018
The awesome list for lit-html has been approved in sindresorhus/awesome#1357
Please consider adding this badge, so as we could help more people with blog posts, tools etc.
@web-padawan web-padawan deleted the add-lit-html branch October 4, 2018 17:49
web-padawan added a commit to web-padawan/lit that referenced this pull request Oct 5, 2018
The awesome list for lit-html has been merged in sindresorhus/awesome#1357
Please consider adding this badge, so as we could help more people with blog posts, tools etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants