CONTRIBUTING.md 759 Bytes
Newer Older
Matthieu Schaller's avatar
Matthieu Schaller committed
1
The SWIFT source code is using a variation of the 'Google' formatting style. 
2
The script 'format.sh' in the root directory applies the clang-format-10
Matthieu Schaller's avatar
Matthieu Schaller committed
3
tool with our style choices to all the SWIFT C source file. Please apply 
4 5 6 7 8 9 10 11
the formatting script to the files before submitting a merge request.

The SWIFT code comes with a series of unit tests that are run automatically 
when a push to the master branch occurs. The suite can be run by doing a `make 
check` in the root directory. Please check that the test suite still
runs with your changes applied before submitting a merge request and add 
relevant unit tests probing the correctness of new modules. An example of how
to add a test to the suite can be found by considering the tests/testGreeting 
12
case.