Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DEV_DOCS: Document the shared Cram setup scripts #1639

Merged
merged 1 commit into from
Sep 24, 2024
Merged

DEV_DOCS: Document the shared Cram setup scripts #1639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/contribute/DEV_DOCS.md
View file
Open in desktop
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
Loading