Skip to content
This repository was archived by the owner on Jan 14, 2025. It is now read-only.

Commit e0c8e6e

Browse files
authored
chore: add contributing guidelines (#129)
1 parent 79177bb commit e0c8e6e

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
# Contributing
3+
4+
MDC React is an open source project that accepts contributions from community members.
5+
6+
## Code of Conduct
7+
8+
The MDC React authors value respect and are committed to making this repository a safe space for all peoples.
9+
10+
To learn more about what to expect from us and what we expect from you, read the [Code of Conduct](https://github.com/material-components/material-components/blob/develop/CODE_OF_CONDUCT.md).
11+
12+
13+
## Issues and Bugs
14+
15+
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue.
16+
17+
Even better: propose a fix with a pull request and link it to the issue!
18+
19+
20+
## Feature or Component Requests
21+
22+
If you want to request a new component, or change to the UX of an existing component, you must first make this request in our [MDC Web repository](https://github.com/material-components/material-components-web/issues/new). Please read the general [Material Design Components Request Policy](https://github.com/material-components/material-components/blob/develop/COMPONENTS_REQUEST_POLICY.md) before you request any changes.
23+
24+
Once the issue is resolved and the component built, we will update our [roadmap](ROADMAP.md) with a timeline that includes wrapping the MDC Web component in MDC React.
25+
26+
27+
## Pull Requests
28+
29+
Please only submit small pull requests, less than 200 lines of modification. MDC React is built by wrapping MDC Web code, so fixes should be isolated to this small wrapping layer of code.
30+
31+
If you think you need a much larger pull request, like an architecture change, then first open an issue detailing your proposed architecture. We will discuss the proposal on the issue thread before we review any code in a pull request.
32+
33+
34+
### Code review
35+
36+
All code goes through code review before it can be merged into main branches.
37+

0 commit comments

Comments
 (0)