Skip to content
This repository has been archived by the owner on Sep 28, 2021. It is now read-only.

Latest commit

 

History

History
36 lines (29 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

36 lines (29 loc) · 1.42 KB
Raw

Welcome to the Project 🎉

First off, thank you for interest in the project.

  • You want to ask a question?
  • You have an idea?
  • You want to give a feedback?
  • or You want to say "Hi"?

Then we are more than welcome to see you on our discord server. It is our main point of discussing issues, ideas and current development areas.

Contributing the code

Don't know where to start to contribute the code? You can:

  1. peek up issue with help wanted or good first issue labels.
  2. submit an issue with proposal to work on interested area for you
  3. ask question on discord server which issue to pick up
  4. have a code changes but stuck with rust/project structure submit a draft PR and ask for feedback

PR, to be merged, has to pass formatting, clippy and unit tests checks. To help you pass CI we have clippy.sh and rustfmt.sh in local folder. All you need is to run following commands and see that there are no errors:

./etc/local/rustfmt.sh
./etc/local/clippy.sh
cargo test

One of the sub-goal of the project is to develop general PostgreSQL Wire Protocol backend in rust, so that rust and database communities could benefit from. So I would love external help on it.