Skip to content

Commit 3f46ab6

Browse files
asyncLizcopybara-github
authored andcommitted
docs: add contributing guide
Fixes #246 PiperOrigin-RevId: 591967524
1 parent 839667d commit 3f46ab6

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing! The following sections describe
4+
ways to get involved.
5+
6+
## Code of conduct
7+
8+
Please review and follow our [code of conduct](CODE_OF_CONDUCT.md).
9+
10+
## Feedback
11+
12+
User feedback is the most valuable to us. It's a great way to start
13+
contributing!
14+
15+
- [File new issues](https://github.com/material-components/material-web/issues/new/choose)
16+
for bugs you run into or feature requests you have.
17+
18+
- [Create a discussion](https://github.com/material-components/material-web/discussions/new/choose)
19+
for help, feedback on changes, or feature proposals.
20+
21+
## Discord
22+
23+
Join the `#material` channel on [Lit's Discord](https://lit.dev/discord) to chat
24+
directly with the team and other users.
25+
26+
## Pull requests
27+
28+
Pull requests are welcome! Keep a few things in mind:
29+
30+
- Create an
31+
[issue](https://github.com/material-components/material-web/issues/new/choose)
32+
or
33+
[discussion](https://github.com/material-components/material-web/discussions/new/choose)
34+
before opening a pull request.
35+
- Trivial changes, such as documentation, don't need an issue.
36+
- Create draft PRs in the `@material/web/labs` folder for new features.
37+
- Please be patient! It may take a while for the team to review. Keep changes
38+
small and scoped to speed things up.
39+
40+
### New components
41+
42+
Please understand that new component implementations are difficult for us to
43+
directly accept. They need to complete several engineer, design, and
44+
accessibility reviews that are not easy with our externally available workflows.
45+
46+
If you want to help build a new component, create a
47+
[new discussion](https://github.com/material-components/material-web/discussions/new/choose).
48+
Add any design docs, code samples, reference implementations in draft PRs, and
49+
get community feedback.
50+
51+
### Contributor License Agreement
52+
53+
Code contributions must
54+
[sign Google's CLA](https://cla.developers.google.com/clas). When you open a
55+
pull request, our friendly bot will check and provide help if you haven't
56+
signed.
57+
58+
[Set your email in git](https://help.github.com/articles/setting-your-email-in-git/)
59+
to the same email used to sign the CLA.

0 commit comments

Comments
 (0)