-
-
Notifications
You must be signed in to change notification settings - Fork 26.9k
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
Add Web Effect #1983
Conversation
This looks great. I notice a bug: [Filippo Bello's Portfolio] Thanks for making it! |
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. |
There was a problem hiding this 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) |
There was a problem hiding this comment.
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.
There was a problem hiding this 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
.
[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
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.
Add Name of List
.Add Swift
Add Software Architecture
Update readme.md
Add Awesome Swift
Add swift
add Swift
Adding Swift
Added Swift
- [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
Requirements for your Awesome list
That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
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.main
, notmaster
.Mobile operating system for Apple phones and tablets.
Prototyping interactive UI designs.
Resources and tools for iOS development.
Awesome Framer packages and tools.
If you have not put in considerable effort into your list, your pull request will be immediately closed.
awesome-name-of-list
.awesome-swift
awesome-web-typography
awesome-Swift
AwesomeWebTypography
# Awesome Name of List
.# Awesome Swift
# Awesome Web Typography
# awesome-swift
# AwesomeSwift
awesome-list
&awesome
as GitHub topics. I encourage you to add more relevant topics.Contents
, notTable of Contents
.Contributing
orFootnotes
sections.https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0
(replace<user>
and<repo>
accordingly).license
orLICENSE
in the repo root with the license text.Licence
section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.unicorn
.contributing.md
. Casing is up to you.Contributing
, positioned at the top or bottom of the main content.Footnotes
section at the bottom of the readme. The section should not be present in the Table of Contents.Example:
- [AVA](β¦) - JavaScript test runner.
Node.js
, notNodeJS
ornode.js
.You can still use Travis for list linting, but the badge has no value in the readme.
Inspired by awesome-foo
orInspired 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.