Back to Material Components Web

How to Contribute

docs/contribute/README.md

14.0.01.1 KB
Original Source

How to Contribute

MDC Web is an open source project, so we encourage contributions! If you are looking for a bug to fix, check out Help Wanted Issues on GitHub. (Or you can file new bugs, which will fall into our Triage Process.)

Fix a Bug

If you want to fix a bug, check out the workflow here.

Add a Feature

We consider any new API to be a new feature. An API is any of the following:

  • Sass Variables, Mixins, Functions
  • CSS classes
  • DOM structure
  • Utility JavaScript Functions
  • Foundation
  • Adapter
  • Component

API changes should be done in a backwards compatible way, a.k.a add new APIs, do not remove old APIs. DOM structure and Adapter methods are the opposite, you cannot add new required DOM structure or Adapter methods, because this is backwards incompatible

If you want to add a feature, check out the workflow here. You can also check out our Code Review Process