CONTRIBUTING.md

Contributing

Thanks for contributing!

Getting Started

• Install rust
• Install dependencies:
  • SQLite: apt install sqlite3 libsqlite3-dev
  • PostgreSQL: apt install postgresql libpq-dev
  • MySQL: See mysql install docs
    • Download the apt repo .deb
    • dpkg -i mysql-apt-config_<version>_all.deb
    • apt update
    • apt install mysql-server mysql-shell
• cargo build

Making Changes

• After making changes, be sure to run the tests (see below)!
• Add an entry to the CHANGELOG

Running Tests

The integration tests assume the Migrant.toml configuration file is present and configured for sqlite.

cargo test
cargo test --features 'sqlite postgres mysql'

Submitting Changes

Pull Requests should be made against master. Travis CI will run the test suite on all PRs. Remember to update the changelog!