Skip to content

Commit 6457421

Browse files
authored
Update CONTRIBUTING.md
1 parent 44b5e7e commit 6457421

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,17 @@
33
Thank you for contributing! Just a few tips here:
44

55
1. `cargo fmt` your code before opening up a PR
6-
2. Run the "test suite" (i.e. PgBench) to make sure everything still works.
6+
2. Run the test suite (e.g. `pgbench`) to make sure everything still works. The tests are in `.circleci/run_tests.sh`.
7+
3. Performance is important, make sure there are no regressions in your branch vs. `main`.
78

89
Happy hacking!
910

1011
## TODOs
1112

12-
A non-exhaustive list of things that would be useful to implement.
13+
A non-exhaustive list of things that would be useful to implement:
1314

1415
#### Client authentication
1516
MD5 is probably sufficient, but maybe others too.
1617

17-
#### Statistics
18-
Same as PgBouncer, e.g. client wait, transactions, timings, etc. I'm thinking we can use `mpsc` here ([docs](https://tokio.rs/tokio/tutorial/channels)), with clients sending stats and a task collecting and aggregating them. This should avoid atomics/mutexes. Caveat is the task should make sure not to crash, so the channels don't get backed up.
19-
2018
#### Admin
2119
Admin database for stats collection and pooler administration. PgBouncer gives us a nice example on how to do that, specifically how to implement `RowDescription` and `DataRow` messages, [example here](https://github.com/pgbouncer/pgbouncer/blob/4f9ced8e63d317a6ff45c8b0efa876b32161f6db/src/admin.c#L813).

0 commit comments

Comments
 (0)