Skip to content

Commit

Permalink
Merge pull request #1639: DEV_DOCS: Document the shared Cram setup sc…
Browse files Browse the repository at this point in the history
…ripts
  • Loading branch information
victorlin authored Sep 24, 2024
2 parents 9c92458 + aa72e5d commit 09cb977
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/contribute/DEV_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Over time, we have changed the way we design and organize Augur's Cram tests. Yo

1. Keep cram files modular. This makes it easier to see which command is failing.
2. Create files in the initial working directory (e.g. `./file.txt` or simply `file.txt`), as it is a temporary working directory unique to the test. Note that the name of the `$TMP` directory is misleading - although it is temporary, it is shared across all tests so you'll have to explicitly remove files at the end of each test to avoid affecting other tests. The initial directory of each test is a unique directory within `$TMP`.
3. Each directory containing cram tests should have a setup script named `_setup.sh`. Keep all shared setup commands in this file.

##### Comparing outputs of augur commands

Expand Down

0 comments on commit 09cb977

Please sign in to comment.