Skip to content

Commit

Permalink
Add CONTRIBUTING.md (#406)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari authored Oct 14, 2020
1 parent 64f0af1 commit 30ee79f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing to Material-UI X

## Material-UI X vs. Material-UI

Material-UI X is an extension of Material-UI.
The repositories are part of the same codebase.
`mui-org/material-ui-x` imports the code infrastructure from [`mui-org/material-ui`](https://github.com/mui-org/material-ui).
You can find the "contributing" guide for the main repository in [mui-org/material-ui/CONTRIBUTING.md](https://github.com/mui-org/material-ui/blob/HEAD/CONTRIBUTING.md).

Most of the content in the Material-UI "contributing" guide applies to this repository.
There are, however, a few differences:

- The default GitHub branch might be different.
- The local documentation site opens on a different port: 3001 instead of 3000.

0 comments on commit 30ee79f

Please sign in to comment.