From 2fcdf3df3473658cf035fe17ac47f967f67b97cb Mon Sep 17 00:00:00 2001
From: Robert Helgesson <robert@rycee.net>
Date: Wed, 26 Feb 2020 22:09:59 +0100
Subject: [PATCH] contributing: add section about tests

---
 CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fa2e3b7b..0518ce08 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -156,6 +156,35 @@ If you do have a change worthy of a news entry then please add one in
   should be added. If you contribute a module then you don't need to
   add this entry, the merger will create an entry for you.
 
+### Tests ###
+
+Home Manager includes a basic test suite and it is highly recommended
+to include at least one test when adding a module. Tests are typically
+in the form of "golden tests" where, for example, a generated
+configuration file is compared to a known correct file.
+
+It is relatively easy to create tests by modeling the existing tests,
+found in the `tests` project directory.
+
+The full Home Manager test suite can be run by executing
+
+```console
+$ nix-shell --pure tests -A run.all
+```
+
+in the project root. List all test cases through
+
+```console
+$ nix-shell --pure tests -A list
+```
+
+and run an individual test, for example `alacritty-empty-settings`,
+through
+
+```console
+$ nix-shell --pure tests -A run.alacritty-empty-settings
+```
+
 [open issues]: https://github.com/rycee/home-manager/issues
 [new issue]: https://github.com/rycee/home-manager/issues/new
 [Fork A Repo]: https://help.github.com/articles/fork-a-repo/