From c077153699b22e093564f0797afe147060948449 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Sat, 12 Apr 2025 18:32:09 +0100 Subject: [PATCH] docs: Mention how to run the test suite in CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We don’t want `CONTRIBUTING.md` to become an exhaustive manual of how to contribute to what is a fairly standard C project using Meson, but it is a fairly helpful hint to mention how to run the test suite. Then people can use `meson test --help` and the Meson documentation to learn more. Pointed out on !4589. Signed-off-by: Philip Withnall --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1cd7bcf72..d901e965d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -153,7 +153,15 @@ Typically, you should work on your own branch: $ git checkout -b your-branch ``` -Once you’ve finished working on the bug fix or feature, push the branch +Once you’ve finished working on the bug fix or feature, make sure the tests +pass by using the standard `meson` test harness: + +```sh +$ meson test -C _builddir +$ meson test -C _builddir --setup=valgrind +``` + +Then push the branch to the Git repository and open a new merge request, to let the GLib core developers review your contribution.