diff options
| author | onqtam <vik.kirilov@gmail.com> | 2017-05-16 00:51:47 +0300 |
|---|---|---|
| committer | onqtam <vik.kirilov@gmail.com> | 2017-05-16 00:51:47 +0300 |
| commit | 7cd2fabc778b9e7c968acfcd0f26a48e449c3f97 (patch) | |
| tree | d3cbf3d2d4baec2be49254708b5a8dd99a391d07 /CONTRIBUTING.md | |
| parent | 8d95bb8404af13785ed89edd454fdd9d85cfa1cb (diff) | |
fixing broken links and tiny mistakes in docs
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e02cb17..813bed9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,9 @@ ## Contributing -This library is free, and will stay free but needs your support to sustain its development. There are lots of [**new features**](roadmap.md) and maintenance to do. If you work for a company using **doctest** or have the means to do so, please consider financial support. +This library is free, and will stay free but needs your support to sustain its development. There are lots of [**new features**](doc/markdown/roadmap.md) and maintenance to do. If you work for a company using **doctest** or have the means to do so, please consider financial support. -[](https://pledgie.com/campaigns/31280) [](http://www.patreon.com/onqtam) -[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3K423Q6TK48BN) +[](https://www.paypal.me/onqtam) ## Pull requests @@ -14,7 +13,7 @@ All pull requests should be made against the ```dev``` branch because the ```mas 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 - so make sure you do a CMake build after you modify them so the ```assemble_single_header``` target gets built. Also take into consideration how the change affects the code coverage - based on the project in ```examples/all_features```. Also update any relevant examples in the ```examples``` folder. -This framework has some design goals which must be kept. Make sure you have read the [**features and design goals**](features.md) page. +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 ```DOCTEST_TEST_MODE``` variable set to ```COLLECT``` (making the new reference output) and then run ```ctest``` and commit the changed (or newly created) ```.txt``` files in the ```test_output``` folders too. The default ```DOCTEST_TEST_MODE``` is ```COMPARE```. |