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 Svelte #1898

Merged
merged 1 commit into from
Dec 19, 2020
Merged

Add Svelte #1898

merged 1 commit into from
Dec 19, 2020

Conversation

TheComputerM
Copy link
Contributor

https://github.com/TheComputerM/awesome-svelte

Svelte is a new and upcoming compiler that compiles to js and makes faster apps as there is no almost no runtime,

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.

@TheComputerM
Copy link
Contributor Author

unicorn

@TheComputerM
Copy link
Contributor Author

Reviewed #1895 and #1896

@niedev
Copy link
Contributor

niedev commented Nov 11, 2020

According to awesome-lint there are some errors.
I suggest you to install awesome-lint, to do this download and install Node.js, then in the Node.js prompt type the command:

npm install --global awesome-lint

Then type awesome-lint from the same prompt followed by the link of awesome repository you want to analyze, in your case:

awesome-lint https://github.com/TheComputerM/awesome-svelte

Finally, the introduction on the contribution should be made at the end of the list under the title "Contributing".

@TheComputerM
Copy link
Contributor Author

Interesting, had no errors locally, will check again, thx.

@TheComputerM
Copy link
Contributor Author

TheComputerM commented Nov 11, 2020

Finally, the introduction on the contribution should be made at the end of the list under the title "Contributing".

This is optional right?

@niedev
Copy link
Contributor

niedev commented Nov 11, 2020

It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.

I was wrong, you can write the introduction even at the top, but, from what I understand, you still have to put the title "Contributing".

@niedev
Copy link
Contributor

niedev commented Nov 11, 2020

If you want to write the introduction to the contribution.

@TheComputerM
Copy link
Contributor Author

I have a valid contributing.md and looking at recent successful PRs, they do not have a dedicated section for that in the README so I will hold off on that.

@niedev niedev mentioned this pull request Nov 14, 2020
51 tasks
@nijaru
Copy link

nijaru commented Nov 15, 2020

lgtm and passes awesome-lint locally.

I don't see an issue with how contribution info is handled in the readme, the guidelines are in their own file and much more descriptive, but I see how it can be interpreted that it isn't following the style guide.

@nijaru nijaru mentioned this pull request Nov 15, 2020
@Ly0n
Copy link
Contributor

Ly0n commented Nov 15, 2020

The linter gives also no errors on my systems. The list looks fine from my point of view. Never heard of Svelt before, thanks for sharing.

@Ly0n Ly0n mentioned this pull request Nov 15, 2020
@niedev niedev mentioned this pull request Nov 16, 2020
51 tasks
@TheComputerM
Copy link
Contributor Author

All the errors have been fixed and this is now compliant with all the rules.

@sindresorhus
Copy link
Owner

Svelte in Svelte is a new way to build web applications. should be linkified to its website.


Toggle component for Svelte.

Svelte is implied there and should be removed. Same in other places.


Let the user create & edit data - should end in a dot. Same in other places. It's also Lets.


Display non-editable events in a Calendar - calendar is not a name.


Check your code with svelte-check.

Repeating the name in the description is moot.

Please go through all the descriptions and try to improve/simplify them.


Some items are missing a description.


Don't use emojis in descriptions.


Descriptions should not be title-case.


Svelte wrapper for leaflet.

Leaflet is a name.

@TheComputerM
Copy link
Contributor Author

Done, some items do not require a description such as Official Resources. Thanks.

@sindresorhus
Copy link
Owner

Descriptions should not be title-case.

⬇️

svelte-simple-icons - Simple Brand Icons.

@sindresorhus sindresorhus merged commit c122c65 into sindresorhus:main Dec 19, 2020
@sindresorhus
Copy link
Owner

@TheComputerM
Copy link
Contributor Author

Done, Thanks 👍🏼 (thought simple brand icons was a name).

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.

5 participants