From 74bbbf0b9b1d08cc218d0941fdcbd241e8f57611 Mon Sep 17 00:00:00 2001 From: Lev Kokotov Date: Sat, 11 Jan 2025 10:09:12 -0800 Subject: [PATCH] Note for contributors --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 3dd627f..6bc1ec0 100644 --- a/README.md +++ b/README.md @@ -143,3 +143,17 @@ share any source code, including proprietary work product or any pgDog modificat AGPL was written specifically for organizations that offer pgDog _as a public service_ (e.g. database cloud providers) and require those organizations to share any modifications they make to pgDog, including new features and bug fixes. + +## Contributions + +Contributions are welcome. If you see a bug, feel free to submit a PR with a fix or an issue to discuss. For any features, +please open an issue to discuss first. + +The code has tests, make sure they pass first with: + +``` +cargo nextest run && \ +cargo fmt --check --all +``` + +`cargo-nextest` is better because it runs tests in parallel and can help surface concurrency bugs.