Skip to content

Commit

Permalink
Actually fixing list.
Browse files Browse the repository at this point in the history
  • Loading branch information
mwaxmonsky committed Nov 6, 2024
1 parent 3aa6580 commit 00c33c7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/atmospheric_physics/development_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ Currently only certain `utilities` modules are being tested but this will expand
If you are adding a new file, attempt to add it to the list of files being built by the `CMakeLists.txt` and if it builds successfuly, add a corresponding unit test. The current workflow is to take your new file in `schemes/{path_to_file}/new_file.F90` and add a corresponding test file in `test/unit-test/tests/{path_to_file}/test_{new_file}.pf`.

At a minimum, unit tests for ESCOMP source code should:
1. Keep the setup code to the absolute minimum needed to effectively assert object/state data (ie, each line before calling `assert`s should be modifying or preparing state data/objects to be modified exactly as a client or user would do).
2. There should only be 1 block/set of `assert` statements per test. If there are multiple sets of `assert`s with module API calls in between each set, that _probably_ would constitute a new test with a different name.
3. Test names should be as explicit as possible. There are going to be hundreds of names in each test report and having the ability for a reviewer/contributor be able to look at a test and intuitively understand what said test is doing is paramount (this is obviously going to vary slightly based on preferrence but the goal is to have a test name be as intuitive as possible).
1. Keep the setup code to the absolute minimum needed to effectively assert object/state data (ie, each line before calling `assert`s should be modifying or preparing state data/objects to be modified exactly as a client or user would do).
2. There should only be 1 block/set of `assert` statements per test. If there are multiple sets of `assert`s with module API calls in between each set, that _probably_ would constitute a new test with a different name.
3. Test names should be as explicit as possible. There are going to be hundreds of names in each test report and having the ability for a reviewer/contributor be able to look at a test and intuitively understand what said test is doing is paramount (this is obviously going to vary slightly based on preferrence but the goal is to have a test name be as intuitive as possible).


**3. Add all the files that you want to commit. There are multiple ways to do this, but one of the safer ways is to first check your status:**
Expand Down

0 comments on commit 00c33c7

Please sign in to comment.