From b3c15daed5b6e21266804e1b3c9911c3ffd9aefb Mon Sep 17 00:00:00 2001 From: Luc Grosheintz Date: Tue, 20 Feb 2024 15:22:08 +0100 Subject: [PATCH] Create repo. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f618b8 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Reference File for NMODL Tests +One aspect of testing NMODL is golden tests of translated MOD files. These +"tests" alert the developer that the code generated for a particular MOD file +changed. This is often desirable, just not without noticing. + +This repository stores these reference values and is includes in NMODL via a +submodule. + +Github as a long standing annoying bug that prevents us from fast-forward +merging PRs. This causes the commit SHA to change on merge. Meaning the SHA in +the NMODL repo points to the PR branch, not the corresponding commit on `main`. + +For out particular usecase, we should require that those commits remain in the +repo.