Skip to content
Ed Jones edited this page Mar 18, 2023 · 5 revisions

Welcome to the react-material-symbols wiki!

React Material Symbols is a library for React that makes it really easy to use Google's Material Symbols. The objective of this library is to be typesafe, unopinionated, flexible and easy to use.

Contributing

We welcome and encourage contributions to the project. The following guide will help if you want to contribute some code for us.

Code Consistency

We use ESLint and Prettier to keep our code's style consistent. Code must be correctly formatted before it can be merged into main. The command for automatically formatting code with prettier is npm run prettier:write, and for eslint the command is npm run eslint:fix.

Commits

Commits must be in the format of Conventional Commits. This keeps the commit history clean, and supports automatic versioning.

Clone this wiki locally