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 Material-UI #1676

Merged
merged 5 commits into from Mar 22, 2020
Merged

Add Material-UI #1676

merged 5 commits into from Mar 22, 2020

Conversation

@nadunindunil
Copy link
Contributor

nadunindunil commented Dec 27, 2019

https://github.com/nadunindunil/awesome-material-ui

Material-UI is a successful react component library and it is one of the famous(more than 50k stars) react libraries.

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.
  • 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
    • ❌ 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.
  • - 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.
  • - 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=master&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 or text to the readme. GitHub already shows the license name 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.
  • - 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.
  • - 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.

@sindresorhus

This comment has been minimized.

Copy link
Owner

sindresorhus commented Dec 27, 2019

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.

@nadunindunil nadunindunil changed the title Add material ui awesome list Add material-ui Dec 27, 2019
@sergey-pimenov

This comment has been minimized.

Copy link
Contributor

sergey-pimenov commented Dec 28, 2019

Hi! You must add some github topics to your repository: "awesome" and "awesome-list". Also you need to remove "Contributing" title from table of content. You can remove the "Contributing" section from readme at all (but this is not necessary). Just keep contributing.md file at repo.

After you solve these problems use awesome-lint to see other issues. I also strongly advise you to read very carefully pull_request_template.md.

@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Dec 28, 2019

@sergey-pimenov thank you very much for the instructions
I am working on changes and I will make them as list points.
I will update and let you know these when I am finished (with unicorn keyword) πŸ‘

@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Dec 29, 2019

unicorn πŸ¦„

@mgramin

This comment has been minimized.

Copy link

mgramin commented Jan 13, 2020

awesome-lint still detects several errors:

  Γ—   1:1  Missing Awesome badge after the main heading       awesome/badge
  Γ—   3:1  Remove empty section: "Awesome Material-UI "       empty-sections
  Γ—   3:1  Don’t use multiple top level headings (3:1)        no-multiple-toplevel-headings
  Γ—   3:3  Remove trailing slash (https://material-ui.com)    trailing-slash
  Γ—   5:1  Remove trailing slash (https://material-ui.com)    trailing-slash
  Γ—  22:3  Remove trailing slash (https://material-ui.com)    trailing-slash
  Γ—  76:3  Remove trailing slash (https://bethesda.net)       trailing-slash
  Γ—  77:3  Remove trailing slash (https://neotracker.io)      trailing-slash
  Γ—  78:3  Remove trailing slash (https://www.tagspaces.org)  trailing-slash
  Γ—  79:3  Remove trailing slash (https://builderbook.org)    trailing-slash

  10 errors
@mgramin mgramin mentioned this pull request Jan 13, 2020
@mgramin

This comment has been minimized.

Copy link

mgramin commented Jan 13, 2020

You should review the guidelines about license again

@angrykoala

This comment has been minimized.

Copy link
Contributor

angrykoala commented Jan 20, 2020

Some of the items under Related Projects seem to be components, in particular material-auto-rotating-carousel and material-ui-image which seem to belong to a set of components (Wertarbyte Material-UI Components). I'm not sure about the difference between these sections (Related Projects and Components) and I feel it may lead to confusion to some people.

@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Feb 2, 2020

I went through the awesome-lint again for the verification
Screen Shot 2020-02-02 at 5 44 09 AM

@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Feb 2, 2020

unicorn πŸ¦„

readme.md Outdated Show resolved Hide resolved
@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Feb 26, 2020

@sindresorhus could you please take a look at this one. do let me know if I have done any mistakes.
Thank you

readme.md Outdated Show resolved Hide resolved
@sindresorhus sindresorhus changed the title Add material-ui Add Material-UI Feb 27, 2020
@sindresorhus

This comment has been minimized.

Copy link
Owner

sindresorhus commented Feb 27, 2020

The link and description are separated by a dash.


Entries have a description


These are tools and utilities to help build apps using Material-UI Design

All sentences should end in a .


It would look nicer if the logo was above the header title. I would also center the title.


Consistent and correct naming.

Applies to the repo description.

@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Feb 27, 2020

Thank you very much for pointing out my mistakes. I am going to change the requested.

  • The link and description are separated by a dash
  • Entries have a description
  • All sentences should end in a "."
  • It would look nicer if the logo was above the header title. I would also center the title.
  • Consistent and correct naming. (Applies to the repo description.)
  • update License file
Co-Authored-By: Sindre Sorhus <sindresorhus@gmail.com>
@ltchris

This comment has been minimized.

Copy link
Contributor

ltchris commented Mar 8, 2020

The repo is using a MIT license, which is not accepted per the guidelines:

A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.

@ltchris ltchris mentioned this pull request Mar 8, 2020
@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Mar 15, 2020

Hi @sindresorhus, I have completed the tasks you requested. However, I couldn't center the Material-UI title since it requires doesn't support native markup. (I moved logo above the title.)
Could you please take a look at this PR!
Thank you.
πŸ¦„

@sindresorhus

This comment has been minimized.

Copy link
Owner

sindresorhus commented Mar 17, 2020

However, I couldn't center the Material-UI title since it requires doesn't support native markup.

This is totally possible. In fact, the readme in this repo does it.

@nadunindunil

This comment has been minimized.

Copy link
Contributor Author

nadunindunil commented Mar 17, 2020

hi @sindresorhus ,
I have centered the Title as you requested.
Could you please take look at this PR.
Thank you.

@nadunindunil nadunindunil requested a review from sindresorhus Mar 17, 2020
@sindresorhus sindresorhus merged commit bd23d06 into sindresorhus:master Mar 22, 2020
@sindresorhus

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

8 participants
You can’t perform that action at this time.