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 Design Systems #1876

Merged
merged 5 commits into from
Jan 17, 2021
Merged

Add Design Systems #1876

merged 5 commits into from
Jan 17, 2021

Conversation

klaufel
Copy link
Contributor

@klaufel klaufel commented Oct 2, 2020

https://github.com/klaufel/awesome-design-systems

About design system definition, is an ever evolving collection of reusable components, guided by rules that ensure consistency and speed, by being the single source of truth for any product development, this awesome list, focused on frontend development of design systems. A curated list of bookmarks, articles and more resources of design systems focused on developers.

PR reviewed

3 pull requests I've reviewed: #1865, #1863 and #1859

#1865 (comment)
#1859 (comment)
#1863 (comment)

[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.

A curated list of bookmarks, resources and articles of design systems focused on developers.
@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.

@klaufel klaufel changed the title Add design system list Add design systems list Oct 4, 2020
@klaufel
Copy link
Contributor Author

klaufel commented Oct 4, 2020

🦄

@klaufel
Copy link
Contributor Author

klaufel commented Oct 4, 2020

@sindresorhus I have updated the list 💪

@androiddevnotes
Copy link

@klaufel According to guidelines: 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.

You repository is not 30 days old.

@klaufel
Copy link
Contributor Author

klaufel commented Oct 8, 2020

@androiddevnotes Hi! The repository was created open-sourced on 20/04/2020, more than 5 months ago.
This is one of first commits: klaufel/awesome-design-systems@260d821

This was referenced Oct 8, 2020
@androiddevnotes
Copy link

@klaufel Thank you for clarifying.

@sdassow
Copy link
Contributor

sdassow commented Oct 10, 2020

First I thought this was about design patterns for developers, but it appears to be about user interface design.
Can the explanation be more clear?

@klaufel
Copy link
Contributor Author

klaufel commented Oct 15, 2020

First I thought this was about design patterns for developers, but it appears to be about user interface design.
Can the explanation be more clear?

Sure @sdassow !
About design system definition, is an ever evolving collection of reusable components, guided by rules that ensure consistency and speed, by being the single source of truth for any product development, this awesome list, focused on frontend development of design systems.

@sdassow sdassow mentioned this pull request Oct 24, 2020
@klaufel
Copy link
Contributor Author

klaufel commented Nov 4, 2020

@sindresorhus it's all up to date, i don't see anything wrong right now :)

@niedev
Copy link
Contributor

niedev commented Nov 11, 2020

I analyzed your list with awesome-lint and you have to rename "Contribute" to "Contributing".

@niedev
Copy link
Contributor

niedev commented Nov 11, 2020

I've already made a pull request with the change

@niedev
Copy link
Contributor

niedev commented Nov 11, 2020

I just noticed that there is already another awesome similar to yours: https://github.com/robinstickel/awesome-design-principles#readme (search "Design Principles" in the readme, Ctrl + F) however yours seems more complete and the other has not had any changes since 2018.
Therefore you could modify your pull request by deleting Design Principles further to add yours (I think the category where you entered your awesome is fine) so sindresorhus will be able to evaluate whether to replace it or not instead of adding a duplicate.

This was referenced Nov 14, 2020
@horverno
Copy link
Contributor

I think instead of Add design systems list should be Add Design Systems

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

@horverno horverno mentioned this pull request Nov 16, 2020
@klaufel klaufel changed the title Add design systems list Add Design Systems Nov 17, 2020
@klaufel
Copy link
Contributor Author

klaufel commented Nov 18, 2020

I think instead of Add design systems list should be Add Design Systems

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

Update PR name, thanks @horverno :)

@klaufel
Copy link
Contributor Author

klaufel commented Nov 18, 2020

I just noticed that there is already another awesome similar to yours: https://github.com/robinstickel/awesome-design-principles#readme (search "Design Principles" in the readme, Ctrl + F) however yours seems more complete and the other has not had any changes since 2018.
Therefore you could modify your pull request by deleting Design Principles further to add yours (I think the category where you entered your awesome is fine) so sindresorhus will be able to evaluate whether to replace it or not instead of adding a duplicate.

Thanks for your PR, when run the linter a few months ago it was not giving that error.

klaufel/awesome-design-systems#9

Next steps: Add an awesome-lint for dependency and includes on the github actions :) Thanks!

What you comment on the other awesome-list, it is focused on design principles but if it has more outdated content, we would have to think about it 🤔

readme.md Outdated
@@ -285,6 +285,7 @@
- [Material-UI](https://github.com/nadunindunil/awesome-material-ui#readme) - Material Design React components for faster and easier web development.
- [Building Blocks for Web Apps](https://github.com/componently-com/awesome-building-blocks-for-web-apps#readme) - Standalone features to be integrated into web apps.
- [Svelte](https://github.com/TheComputerM/awesome-svelte#readme) - App framework.
- [Design systems](https://github.com/klaufel/awesome-design-systems#readme) - An ever evolving collection of reusable components, guided by rules that ensure consistency and speed, by being the single source of truth for any product development.
Copy link
Owner

Choose a reason for hiding this comment

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

Would be great if you could shorten the description slightly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, now the description is on one line.

@sindresorhus sindresorhus merged commit 9b17814 into sindresorhus:main Jan 17, 2021
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1350743496752132103

rogercuddy added a commit to rogercuddy/awesome that referenced this pull request Jan 17, 2021
make-github-pseudonymous-again added a commit to aureooms-contrib/awesome that referenced this pull request Feb 24, 2021
* upstream/main:
  Meta tweaks
  Add DOS (sindresorhus#1917)
  Update readme.md
  Fix a link
  Update a link
  Add Games of Coding (sindresorhus#1933)
  Add Design Systems (sindresorhus#1876)
  Minor tweaks
  Add Veganism (sindresorhus#1886)
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.

7 participants