Skip to content

Adding some information about getting the test suite to run locally #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 24, 2025
Merged

Adding some information about getting the test suite to run locally #183

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6d103d
Adding some information about getting the test suite to run locally
josephhammerman1979 May 23, 2025
d3cea88
Update CONTRIBUTING.md
levkk May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@

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.

## Dev setup

1. Run cargo build in the project directory.
2. Install Postgres (v17 currently supported). Create a `pgdog` superuser with a `pgdog` password.
3. Run the setup script `bash integration/setup.sh`.
2. Launch the pgdog process `cargo run`.
3. Run the tests `cargo nextest run --test-threads=1`. If a test fails, try running it directly.

## Coding

1. Please format your code with `cargo fmt`
2. If you're feeeling generous, `cargo clippy` as well
1. Please format your code with `cargo fmt`.
2. If you're feeeling generous, `cargo clippy` as well.
3. Please write and include tests. This is production software used in one of the most important areas of the stack.