Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.42 KB
Raw

Welcome to the contributing guide for Material Design React!

This file is a work in progress, your are welcome to contribute towards bringing this guide to completion.

Most wanted

  1. Implement missing Components. Read the issue and read the guide
  2. Improve MDLHook decorator. Read the issue.
  3. Write tests. Read the issue.

Contributing

  1. Figure out what bugs you
  2. Open an issue (or add your comment)
  3. State you want to work on a particular problem.
  4. Start developing.

Oh, and use emoticons to your ❤️ wishes 😉

Developing

  1. Fork the project.
  2. Install dependencies via npm install.
  3. Start a server for src/examples via gulp serve.
  4. Write code and add examples/.
  5. Build the project via gulp.
  6. Make sure your code is lint-error free.
  7. Make sure the project installs via npm install -g .
  8. Open a pull request.

Style guide

In lieu of a formal styleguide, take care to maintain the existing coding style. Lint your code using gulp with eslint (you may suggest .eslintrc changes).

Also we use Babel configured with stage: 0, meaning you can use all the (maybe) coming goodness.