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 Web Effect #1983

Closed
wants to merge 1 commit into from
Closed

Add Web Effect #1983

wants to merge 1 commit into from

Conversation

BlazerYoo
Copy link

[Insert URL to the list here]

[Explain what this list is about and why it should be included here]

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

  • 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.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • βœ… 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 about 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.
    • βœ… - [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 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.
  • 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.
  • 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 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.
      • 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. 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.
  • Doesn't use hard-wrapping.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't 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.

@ghost
Copy link

ghost commented Apr 11, 2021

This looks great. I notice a bug: [Filippo Bello's Portfolio]

Thanks for making it!

@sindresorhus
Copy link
Owner

Thanks for making an Awesome list! πŸ™Œ

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

Copy link

@morinted morinted left a comment

Choose a reason for hiding this comment

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

I think you didn't really read the guidelines, as your list meets almost none of them, and your PR description is just the template.

Right away, noticed that the primary branch is called master instead of main, which is listed pretty clearly in the guidelines.

Here's the result of running awesome-lint, please note that awesome-lint is not exhaustive, there are issues with your list beyond what is listed here:

% npx awesome-lint https://github.com/lindelof/awesome-web-effect
βœ– Linting

  README.md:21:106
  βœ–    1:1    Main heading must be in title case                           remark-lint:awesome-heading
  βœ–    1:1    Missing Awesome badge after the main heading                 remark-lint:awesome-badge
  βœ–    1:1    Missing file contributing.md                                 remark-lint:awesome-contributing
  βœ–    1:1    The repository should have "awesome-list" as a GitHub topic  remark-lint:awesome-github
  βœ–    1:1    License was not detected by GitHub                           remark-lint:awesome-github
  βœ–    1:1    Forbidden license section found                              remark-lint:awesome-license
  βœ–    1:1    Missing or invalid Table of Contents                         remark-lint:awesome-toc
  βœ–   16:59   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   20:171  Should not repeat "."                                        remark-lint:no-repeat-punctuation
  βœ–   21:106  Found reference to undefined definition                      remark-lint:no-undefined-references
  βœ–   22:3    https://github.com/rewish/jquery-bgswitcher                  remark-lint:double-link
  βœ–   24:133  Should not repeat "."                                        remark-lint:no-repeat-punctuation
  βœ–   31:71   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   33:79   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   34:90   Should not repeat "."                                        remark-lint:no-repeat-punctuation
  βœ–   34:91   Should not repeat "."                                        remark-lint:no-repeat-punctuation
  βœ–   35:68   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   37:68   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   38:61   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   39:59   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   40:47   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   43:85   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   44:79   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   45:62   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   47:54   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   48:65   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   50:71   Text "Javascript" should be written as "JavaScript"          remark-lint:awesome-spell-check
  βœ–   51:75   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   52:49   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   53:51   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   56:57   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   57:64   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   58:59   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   58:59   Text "Javascript" should be written as "JavaScript"          remark-lint:awesome-spell-check
  βœ–   59:74   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   61:74   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   62:147  Should not repeat "."                                        remark-lint:no-repeat-punctuation
  βœ–   63:3    https://github.com/rewish/jquery-bgswitcher                  remark-lint:double-link
  βœ–   66:60   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   67:86   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   68:51   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   70:165  Should not repeat "."                                        remark-lint:no-repeat-punctuation
  βœ–   72:71   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   75:67   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   77:61   Text "javascript" should be written as "JavaScript"          remark-lint:awesome-spell-check
  βœ–   78:43   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   84:60   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   85:67   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   88:57   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   90:90   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–   91:94   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  101:58   List item description must start with valid casing           remark-lint:awesome-list-item
  βœ–  102:55   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  106:70   List item description must start with valid casing           remark-lint:awesome-list-item
  βœ–  109:52   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  109:52   Text "javascript" should be written as "JavaScript"          remark-lint:awesome-spell-check
  βœ–  113:64   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  114:85   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  119:78   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  123:80   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  127:52   List item description must start with valid casing           remark-lint:awesome-list-item
  βœ–  129:64   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  132:71   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  135:76   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  136:62   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  139:76   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  140:54   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  141:67   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  142:70   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  143:3    https://github.com/EvanBacon/expo-chroma-key-camera          remark-lint:double-link
  βœ–  143:80   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  144:3    https://github.com/EvanBacon/expo-chroma-key-camera          remark-lint:double-link
  βœ–  144:75   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  145:66   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  149:49   Text "Javascript" should be written as "JavaScript"          remark-lint:awesome-spell-check
  βœ–  149:49   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  150:74   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  152:75   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  155:86   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  156:72   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  157:64   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  158:65   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  161:61   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  161:61   Text "javascript" should be written as "JavaScript"          remark-lint:awesome-spell-check
  βœ–  164:56   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  165:64   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  166:60   List item description must start with valid casing           remark-lint:awesome-list-item
  βœ–  169:66   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  170:60   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  171:69   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  173:47   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  173:47   Text "Javascript" should be written as "JavaScript"          remark-lint:awesome-spell-check
  βœ–  174:82   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  175:88   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  176:67   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  186:51   List item description must end with proper punctuation       remark-lint:awesome-list-item
  βœ–  194:1    https://creativecommons.org/licenses/by/4.0/                 remark-lint:double-link
  βœ–  196:31   https://creativecommons.org/licenses/by/4.0/                 remark-lint:double-link

  98 errors

@@ -226,6 +226,7 @@
- [ES6 Tools](https://github.com/addyosmani/es6-tools#readme)
- [Web Performance Optimization](https://github.com/davidsonfellipe/awesome-wpo#readme)
- [Web Tools](https://github.com/lvwzhen/tools#readme)
- [Web Effects](https://github.com/lindelof/awesome-web-effect#readme)

Choose a reason for hiding this comment

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

Whether it's web effect or web effects should be consistent.

@ghost ghost mentioned this pull request Apr 12, 2021
Copy link

@ringabout ringabout left a comment

Choose a reason for hiding this comment

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

You need to change the templates and add the PRs you reviewed. And your repo should be labeled with awesome list.

@ringabout ringabout mentioned this pull request Apr 26, 2021
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