Contributing

Thanks for wanting to contribute to Diesel! We are very much looking forward to your suggestions, bug reports, and pull requests.

Aside from Github, we have an active Gitter channel, where you can ask questions and get help on how to use Diesel. Feel free to ask there before opening an issue or pull request on Github.

Remember: Anyone who interacts with Diesel in any space including but not limited to this GitHub repository is expected to follow our code of conduct.

Submitting bug reports

Have a look at our issue tracker. If you can't find an issue (open or closed) describing your problem (or a very similar one) there, please open a issue with the following details:

  • Which versions of Rust and Diesel are you using?
  • Which feature flags are you using?
  • What are you trying to accomplish?
  • What is the full error you are seeing?
  • How can we reproduce this?
    • Please quote as much of your code as needed to reproduce (best link to a public repository or a Gist)
    • Please post as much of your database schema as is relevant to your error

Thank you! We'll try to get back to you as soon as possible.

Submitting feature requests

If you can't find an issue (open or closed) describing your idea on our issue tracker, open an issue. It would be great if you could answer the following questions in your description:

  • What do you want to do and how do you expect Diesel to support you with that?
  • How do you think this can be added to Diesel?
  • What are possible alternatives?
  • Are there any disadvantages?

Thank you! We'll try to get back to you as soon as possible.

Contribute code to Diesel

Setting up Diesel locally

  1. Install Rust using rustup, which allows you to easily switch between Rust versions.

  2. Install the system libraries needed to interface with the database systems you which to use.

    These are the same as when compiling diesel. In general, it is a good idea to have all drivers installed so you can run all tests locally.

    Shortcut: On macOS, you don‘t need to install anything to work with SQLite and for PostgreSQL you’ll only need the server (libpq is installed by default). So, to get started, brew install postgresql mysql and follow the instructions shown to set up the database servers.

  3. Clone this repository and open it in your favorite editor.

  4. Create a .env file in the diesel/ directory, and add the connection details for your databases.

    For example:

    PG_DATABASE_URL=postgresql://localhost/diesel_test
SQLITE_DATABASE_URL=/tmp/diesel_test.sqlite
MYSQL_DATABASE_URL=mysql://localhost/diesel_test
MYSQL_UNIT_TEST_DATABASE_URL=mysql://localhost/diesel_unit_tests

    Note: If you didn‘t specify the MySQL user to be one with elevated permissions, you’ll want to a command like mysql -c "GRANT ALL ON `diesel_%`.* TO ''@'localhost';" -uroot, or something similar for the user that you've specified.

  5. Now, try running the test suite to confirm everything works for you locally by executing bin/test. (Initially, this will take a while to compile everything.)