elm-ui-widgets/.github/pull_request_template.md
2020-07-16 07:09:52 +02:00

949 B

Description

Please add a detailed description what you did.

Pull request solving issue #[your issue].

Please only open Pull Requests for existing issues.

Checklist for new Widget

  • Checked out the Material design specification of the widget
  • Added constructors and Widgets Type in src/Internal/[Your Widget].elm
  • Added Style Type in src/Widget/Style.elm
  • In src/Widget.elm:
    • Added a copy of the Widget Type
    • Added a copy of each constructor
    • Linked each constructor to its representative in src/Internal/[You Widget].elm
    • Replaced the Style Type in the type signiture of each constructor with its definition
    • Added Documentation
  • Added a Template style in src/Widget/Style/Template.elm

Optional:

  • Added a Material design style in src/Widget/Style/Material.elm
  • Added a Ellie to the docs (+ copied it into example/src/Example/[Your Widget].elm)