elm-ui-widgets/.github/pull_request_template.md
2021-06-09 18:03:13 +02:00

1.1 KiB

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, Widgets Type and Style Type in src/Internal/[Your Widget].elm
  • Added styles in src/Internal/Material/[Your Widget].elm
  • In src/Widget.Material.elm:
    • Linked each style to its representative in src/Internal/Material/[Your Widget].elm
    • Added Documentation
  • In src/Widget.elm:
    • Added a copy of the Widget Type
    • Added a copy of the Style Type
    • Linked each constructor to its representative in src/Internal/[You Widget].elm
    • Replaced the Widget Type in the type signiture of each constructor with its definition
    • Added Documentation with a small example
    • run elm-verify-examples && elm-test to test the example

Optional:

  • Added a Page in explorer/src/Page/[Your Widget].elm and added it to explorer/src/Main.elm