Current section

Files

Jump to
retort CONTRIBUTING.md
Raw

CONTRIBUTING.md

# Contributing
## Forking
[Fork this repository](https://github.com/C-S-D/alembic/fork)
## Development
1. Create your feature branch (`git checkout -b my-new-feature`)
2. Commit your changes (`git commit -am 'Add some feature'`)
3. Push to the branch (`git push origin my-new-feature`)
## Testing
1. Ensure all unit and doctests pass: `mix test`
2. Ensure all style and consistency checks pass: `mix credo --strict`
3. Ensure no dialyzer warnings: `mix dialyze`
4. Ensure no "Closing unclosed backquotes" in docs: `mix docs`
## Pull Request
[Create a Pull Request](https://github.com/C-S-D/alembic/compare/)