Contributing

Drab team (big name for a one person so far) welcomes everyone to be a part of the team!

How to contribute to Drab

Reporting bugs

If you think you’ve found a bug, please report it! It really helps to build a better software.

  • Check the Issues on Github to ensure that this one was not already reported
  • Open a new issue with the problem description and following information:

    • version of Elixir, Phoenix and Drab
    • code samples

If you don’t want to create an issue on Github, please report it directly to grych@tg.pl

Correct docs: fix typos, syntax etc

Drab needs help with the documentation: it must be more clear to readers and checked for typos, sytax.

  • Create a new Pull Request on Github without reporting it as a bug. Label it as docs

Proposing changes

  • Post the proposal on Drab’s thread on elixirforum.com
  • Or create an issue with label change proposal.

Contributing to the code

  • Clone Drab and make the changes in your copy, in master
  • Ensure is pass all the tests (see README). If you adding functionality, write your own tests. Please use hound for integration tests.
  • Create a Pull Request

Anything else

Drop me an email to grych@tg.pl.