Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions EGM.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ Build and packaging (`CMakeLists.txt`):
`project(VERSION)`), `sanitize.sh` (ASan/UBSan or TSan on EL9) and `sl7-ups.sh` (SL7 container,
UPS gcc 12 and HDF5 1.12.2).
- tests (not documented by contract): doctest unit tests and the test data under `tests/data/`.
- docs: design documents, prose only, no contract file.
[./docs/designs/following-spine-releases.md](./docs/designs/following-spine-releases.md) is
the design that pull requests 1 to 6 implemented: the library's version, the tests that
survive expected SPINE changes, the fixture and release tooling, and CI. Its section "As
built" records where the code differs from the plan. The companion
`following-spine-releases.cafmaker-fields.tsv` lists the 228 model fields the CAFMakers read,
from which `tests/test_contracts.cpp` was written.

## Global Invariants

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Status: under construction.
| `tools/fixtures/` | Writes the test files in `tests/data/` with SPINE's own writer, plus expected values. |
| `tools/release/` | Tooling for following SPINE releases: `follow_spine.py` runs one SPINE tag end to end, `classify.py` proposes the version bump, `scan_consumer_fields.py` lists the model fields a CAFMaker build reads ([README](tools/release/README.md)). |
| `tests/` | doctest unit tests (`test_*.cpp`). |
| `docs/designs/` | Design documents: [following SPINE releases](docs/designs/following-spine-releases.md) (the version, the tests, the fixture and release tooling, CI), with the table of the model fields the CAFMakers read. |

## Build

Expand Down
Loading