You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,9 @@ For neXtSIM_DG we use clang-format and the [Webkit style](https://webkit.org/cod
20
20
- Names and values of physical constants reside in src/include/constants.hpp
21
21
- Runtime modifiable model parameters are set in src/options.cpp and can be set using option files.
22
22
23
-
A [dedicated clang format file](https://github.com/nextsimdg/nextsimdg/blob/issue9_clang_format/src/.clang-format) has been designed for the code. You may run it loccaly and manually with the command ```clang-format -i $yourfile``` or have a plugin with your favorite code editor or implement a git pre-commit hook locally by putting this pre-commit file in your .git/hooks/. This clang formatting will also be run each time a pull request is done as part of the continuous integration.
23
+
A [dedicated clang format file](https://github.com/nextsimdg/nextsimdg/blob/issue9_clang_format/src/.clang-format) has been designed for the code. You may run it locally and manually with the command ```clang-format -i $yourfile``` or have a plug-in with your favourite code editor or implement a git pre-commit hook locally by putting this pre-commit file in your .git/hooks/. This clang formatting will also be run each time a pull request is done as part of the continuous integration (see [continuous integration script](https://github.com/nextsimdg/nextsimdg/blob/develop/.github/workflows/clang-compile-tests.yml).
24
+
25
+
For each file file.cpp in src/, an associated test file file_test.cpp shall be created in test/ and contain all the associated tests. The executable produced by these files must start with the sub-string ```test```. As an example the [test file](https://github.com/nextsimdg/nextsimdg/blob/develop/test/Iterator_test.cpp) for the [Iterator file](https://github.com/nextsimdg/nextsimdg/blob/develop/src/Iterator.cpp) produce [testIterator executable](https://github.com/nextsimdg/nextsimdg/blob/develop/test/CMakeLists.txt)
24
26
25
27
26
28
## Commenting conventions for a nice automatic documentation
0 commit comments