diff options
| author | Kevin Song <chipbuster@users.noreply.github.com> | 2019-08-21 09:37:43 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-21 09:37:43 -0700 |
| commit | da86b4f8476221a513bde489f9fc119bb005f1be (patch) | |
| tree | 1fe0a5ce0da2d07f3352749575dd2e681e877ed7 /CONTRIBUTING.md | |
| parent | faa22806207c61c578fe5e302b65ae74b64c47be (diff) | |
fix: Failing Tests if home is a git directory (#214)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 376522025..f59950fef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,6 +70,8 @@ Unit tests are written using the built-in Rust testing library in the same file Unit tests should be fully isolated, only testing a given function's expected output given a specific input, and should be reproducible on any machine. Unit tests should not expect the computer running them to be in any particular state. This includes having any applications pre-installed, having any environment variables set, etc. +The previous point should be emphasized: even seemingly innocuous ideas like "if we can see the directory, we can read it" or "nobody will have their home directory be a git repo" have bitten us in the past. Having even a single test fail can completely break installation on some platforms, so be careful with tests! + ### Acceptance Testing Acceptance tests are located in the [`tests/`](tests) directory and are also written using the built-in Rust testing library. |