CONTRIBUTING.md

Contributing

All contributions are appreciated and welcome. If we meet in real life, I'll gladly buy you a beverage of your choosing.

Guidelines

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making the proposed change. This is to ensure the best use of everyone's time, and that the change is acceptable by all parties.

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

A good guideline for going about contributing to a Haskell project is Neil Mitchell's "Drive-by-Haskell Contributions" presentation.

video / slides

When making PR's

• Do fork master
• Do rebase squash / fixup as you see fit (so as to keep changes atomic)
• Do include documentation (where applicable)
• Do include tests (where applicable)
• Don't bump the package version, that will be handled when a release is made
• Don't just make one-off formatting or stylistic changes (i.e. rearrange the deck chairs)
• Do have fun, use emojis 🍜

Call for participation

Things miso really needs help with

• Better Documentation
  • More Haddocks
  • Better "Quick Start" guides
    • Getting started with nix
    • Getting started with stack
    • client / server setup walkthrough guide (for both nix, stack, cabal)
  • Introductory materials
    • Blog posts
    • User experiences, comparisons
    • JS minification, cabal file setup, configuration walk-throughs
• Press
  • Get the word out, blog, tweet, fb, etc
• Testimonials
  • Are you using miso in any capacity? Please let us know!
• More tests
  • https://github.com/dmjio/miso/blob/master/tests/Main.hs#L20
• Anything listed as low-hanging-fruit / help-wanted in the issues
• Anything you think this project would benefit greatly from