Mirrors/sqlx
2
0
Fork 0
mirror of https://github.com/launchbadge/sqlx synced 2024-11-10 14:34:19 +00:00
Code Issues Projects Releases Packages Wiki Activity
sqlx/CONTRIBUTING.md
Valerio Pipolo 5e23969d94
Add more information to include for new issues
2020-03-31 14:05:00 +02:00

1.7 KiB
Raw Blame History

How to contribute

So, you've decided to contribute, that's great!

You can use this document to figure out how and where to start.

Getting started

  • Make sure you have a GitHub account.
  • Take a look at existing issues.
  • If you need to create an issue:
    • Make sure to clearly describe it.
    • Including steps to reproduce when it is a bug.
    • Include the version of SQLx used.
    • Include the database driver and version.
    • Include the database version.

Making changes

  • Fork the repository on GitHub.
  • Create a branch on your fork.
    • You can usually base it on the master branch.
    • Make sure not to commit directly to master.
  • Make commits of logical and atomic units.
  • Make sure you have added the necessary tests for your changes.
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the original repository.

What to work on

We try to mark issues with a suggested level of experience (in Rust/SQL/SQLx). Where possible we try to spell out how to go about implementing the feature.

To start with, check out:

Additionally, it's always good to work on improving/adding examples and documentation.

Communication

If you're unsure about your contribution or simply want to ask a question about anything, you can: