Skip to content

Latest commit

 

History

History
119 lines (81 loc) · 4.92 KB

CONTRIBUTING.md

File metadata and controls

119 lines (81 loc) · 4.92 KB
Raw

Contributing

Please do! You can report issues, add documentation, fix bugs, enhance the demo, or add components.

Quick links:

Reporting issues

One very helpful and very easy way to contribute is to open an issue for any bug you find. No bug is too small: we intend elm-mdl to provide a completely smooth experience with Material Design for elm developers.

Can I speed up my issue?

We can't make any promises, but there are a few things you can do to speed up the process:

  • Make sure your issue contains only one bug/feature request. Feel free to open more issues.

  • Search the known issues to make sure your issue isn't already known. It might have a known workaround.

    For example, see #93.

  • Check if your issue is a known bug in Google's Material Design Lite ("upstream") and provide a link to the upstream issue if possible.

    It happens frequently that the upstream issue contains an easy solution that can't be implemented upstream for backwards compatibility reasons, but which we can easily implement in elm-mdl; such issues we can resolve real quick.

    For an example, see #127.

  • Provide a link where we can see the code that fails.

  • Provide a PR with a fix yourself.

Contributing code

TL;DR: Check this list.

The elm-mdl library has opportunities for both newcomers and experienced Elm programmers: adding documentation, fixing bugs, enhancing the demo and adding missing features is a good way to get deeper into the language; for experienced programmers, every step of the way (so far) has been a surprisingly subtle and complex challenge in finding proper APIs and working around limitations in Elm.

Add documentation

This is perhaps the easiest place to start. In some cases, documentation can be based more or less directly on the MDL documentation. In other cases, you'll need to read the code needing documentation. If you are new to Elm, this could be a good way to get deeper into the language.

See the documentation issue list

Improve the demo

The demo is always in need of attention: You could add code samples (real easy), add better samples, animations. Contributing to the demo is an easy place to start and a good way to get acquainted with the library.

See the demo issue list.

Fix bugs

Bugfixes, no matter how small, are always very welcome.

See the bug issue list.

Enhance existing components

Some components are stable but not fully featured. Adding minor features could be a good way to get started.

See the enhancement issue list.

Implement new components

The library presently implements all components of Google's Material Design Lite 1.2.0. But you could contribute a component not covered by MDL.

See the missing component list.

If you want to implement a component not on the above list (date/time pickers, anyone?), we'd love that! Do open an issue for your component before starting work, to avoid duplication of efforts.

Getting started with a new component

Each component has its actual code in src/Material/NameOfComponent.elm and a demo in demo/Demo/NameOfComponent.elm. These are what you need to construct. To get started quickly, do this:

  1. Clone this repository
  2. Copy the file src/Material/Template.elm to src/Material/NameOfYourComponent.elm. Rename as appropriate in the file.
  3. Copy the file demo/Demo/Template.elm to demo/Demo/NameOfYourComponent.elm. Rename as appropriate in the file.
  4. In demo/Demo.elm, find all the places that mentions template or Template, copy those bits, and rename as appropriate.
  5. Copy the template bits in src/Material.elm.
  6. Compile and open page.html in a browser.

The last tab contains your component. Now all you need is code!

To avoid duplication of work, either indicate your interest in an existing issue, or open a new one.

What's next?

Once you have some code in place, consider taking a look at our guidelines for submitting a pull request.