From 8aac7148f28533298339426439884c772e04ec9e Mon Sep 17 00:00:00 2001 From: syl20bnr Date: Fri, 23 Aug 2024 14:51:35 -0400 Subject: [PATCH] Update CONTRIBUTING file to mention integration tests --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2b0783f79b..aaf8c54c448 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -114,6 +114,11 @@ _Think of `expect()` messages as guidelines for future you and other developers. This approach ensures that `expect()` messages are informative and aligned with the intended function outcomes, making debugging and maintenance more straightforward for everyone. +### Writing integration tests + +[Integration tests](https://doc.rust-lang.org/rust-by-example/testing/integration_testing.html) should be in a directory called `tests` +besides the `src` directory of a crate. Per convention, they must be implemented in files whose name start with the `test_` prefix. + ## Others To bump for the next version, install `cargo-edit` if its not on your system, and use this command: