Skip to content

Commit

Permalink
Merge pull request #559 from catho/QTM-698
Browse files Browse the repository at this point in the history
docs(QTM-698): Inclusion in the docs of the suggestion not to use MUI in implem
  • Loading branch information
MarcosViniciusPC authored May 10, 2024
2 parents d80541e + c1f9b8d commit 3edf66a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
13 changes: 11 additions & 2 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
## Summary

- [Contribution Prerequisites](#contribution-prerequisites)
- [Important Notices](#important-notices)
- [Getting Started](#getting-started)
- [Editing a Component](#editing-a-component)

Expand All @@ -13,7 +14,7 @@ You can contribute in many ways: opening or participating of a issue, reporting

## Contribution Prerequisites

- Node v16.15.1;
- Node v16.17.1;

Obs.: We have .nvmrc. When you run nvm use, it will set the node to the same version based on the .nvmrc file in the repository.

Expand All @@ -26,7 +27,15 @@ Obs.: We have .nvmrc. When you run nvm use, it will set the node to the same ver
Why _commitizen_? To enforce a padronization to the commits and make sure every commit follows the same profile.

---
## Important Notices ⚠️

We do not recommend using ready-made components from [MUI](https://mui.com/material-ui/getting-started/) when implementing Quantum components for performance and long-term maintenance reasons. MUI is included in our library only to enable the use of [Material Icons](https://mui.com/material-ui/material-icons/).

The MUI library, as well as the Styled Components, uses internally resources and libraries that aren't compatible with [Server Components](https://nextjs.org/docs/app/building-your-application/rendering/server-components), a resource added to Next JS 13. We intend to enable its use in the future to improve the performance of our components. Therefore, we plan to remove the mentioned libraries completely from our components.

Also, we do not recommend using any other ready-made component library. We suggest for new components to have DOM structure, styling and functionalities completely implemented internally, without any dependence on third-party libraries.

---
## Getting Started
1. Fork the project, [Help Guide to Fork a repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo);
2. Clone the project;
Expand Down Expand Up @@ -127,7 +136,7 @@ Why _commitizen_? To enforce a padronization to the commits and make sure every

13. Submit a pull request;

Open your pull request. If you don't know how do it, check this [tutorial](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
Open your pull request. If you don't know how do it, check this [tutorial](https://docs.github.com/pt/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
14. Review flow for Pull Requests:
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
> **Warning**
> Quantum requires [email protected] or higher.
## Notices ⚠️

For performance and long-term maintenance reasons, we do not recommend using [MUI](https://mui.com/material-ui/getting-started/) in Quantum components implementation. MUI is present in our library only to allow the use of [Material Icons](https://mui.com/material-ui/material-icons/).

Also, we do not recommend using any other ready-made component library. We suggest for new components to have DOM structure, styling and functionalities completely implemented internally, without any dependence on third-party libraries.

For more details, visit the "Important notices" section at [CONTRIBUTING.MD](https://github.com/catho/quantum/blob/master/CONTRIBUTING.MD#important-notices)

## Getting started

Quantum is available as an [npm package](https://github.com/catho/quantum/pkgs/npm/quantum). It can be installed using:
Expand Down

0 comments on commit 3edf66a

Please sign in to comment.