Mirrors/home-manager
2
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-22 20:53:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

contributing: add section about tests

Browse source
This commit is contained in:
Robert Helgesson 2020-02-26 22:09:59 +01:00
parent aedde6dcde
commit 2fcdf3df34
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.md
View file

@ -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 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. 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 [open issues]: https://github.com/rycee/home-manager/issues
[new issue]: https://github.com/rycee/home-manager/issues/new [new issue]: https://github.com/rycee/home-manager/issues/new
[Fork A Repo]: https://help.github.com/articles/fork-a-repo/ [Fork A Repo]: https://help.github.com/articles/fork-a-repo/