Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 1.02 KB

CONTRIBUTING

Bug reports and pull requests are welcome on GitHub at https://github.com/hashrocket/tilex.

Issues

To open a new issue, visit our Github Issues page.

Pull Requests

To open a pull request, please follow these steps:

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Make some changes with accompanying tests
  4. Ensure the entire test suite passes (mix test)
  5. Stage the relevant changes (git add --patch)
  6. Commit your changes (git commit -m 'Add some feature')
  7. Push to the branch (git push origin my-new-feature)
  8. Create new Pull Request

All pull requests are checked for style using the Elixir autoformatter (requires Elixir 1.6 or greater) and Credo. Run both to confirm that your code will pass:

$ mix format
$ mix credo

Adding a database migration? Ensure it can be rolled back with this command:

$ mix ecto.twiki