diff options
| author | onqtam <vik.kirilov@gmail.com> | 2016-06-02 10:30:07 +0300 |
|---|---|---|
| committer | onqtam <vik.kirilov@gmail.com> | 2016-09-21 15:46:07 +0300 |
| commit | a731256bd8a40678fde65a61c2342cb1ecbb38e5 (patch) | |
| tree | f4c09e242971341e2a832d968204faf39636f82a /CONTRIBUTING.md | |
| parent | e8bdda4c5c8affc22a06ebb10056631ff547679a (diff) | |
updated contributing.md
moved some macros to the bottom of the header
touched the alignment of BDD style output
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 9628b03..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,26 +0,0 @@ -## Contributing - -Support the development of the project with donations! There is a list of planned features which are all important and big - see the [**roadmap**](doc/markdown/roadmap.md). I took a break from working in the industry to make open source software so every cent is a big deal. - -[](https://pledgie.com/campaigns/31280) - -## pull requests - -Consider opening an issue for a discussion before making a pull request to make sure the contribution goes smoothly. - -All pull requests should be made against the ```dev``` branch because the ```master``` is the stable one with the latest release. - -If you're going to change something in the library itself - make sure you don't modify ```doctest/doctest.h``` because it's generated from ```doctest/parts/doctest_fwd.h``` and ```doctest/parts/doctest_impl.h``` - they get concatenated by CMake! - -This framework has some design goals which must be kept. Make sure you have read the [**features and design goals**](doc/markdown/features.md) page. - -If your changes also change the output of the library - you should also update the reference output for the tests or otherwise the CI builds (```travis``` and ```appveyor```) will fail when they compare the latest output to the outdated reference output (which is committed in the repository). To do this run CMake with the ```TEST_MODE``` variable set to ```COLLECT``` (making the new reference output) and then run ```ctest``` and commit the changed ```.txt``` files too. The default ```TEST_MODE``` is ```COMPARE```. - -Example: ```cmake -DTEST_MODE=COLLECT path/to/sources && ctest``` - -Code should be formatted with a recent-enough ```clang-format``` using the config file in the root of the repo (or I will do it...) - -Testing with compilers different from GCC/Clang/MSVC (and more platforms) is something the project would benefit from. - - - |