diff options
author | Dimitrij Mijoski <dmjpp@hotmail.com> | 2019-02-18 16:56:04 +0300 |
---|---|---|
committer | Viktor Kirilov <vik.kirilov@gmail.com> | 2019-02-18 16:56:04 +0300 |
commit | 447b155552d7df291dcf1eaa5e67d4abb778e1ac (patch) | |
tree | 725d428f16b86b372824973af7dd4ea8433f781c /CONTRIBUTING.md | |
parent | b2611a140fe67d983b7078a3d3cf76a79efaaa9b (diff) |
Rename doctest_impl.h to doctest.cpp for less confusion. (#185)
doctest_impl.h was not really a header file, it contains ODR definitions.
It was meant to be included by one and exactly one implementation file.
It was confusing for contributors. Now it is more clear.
Catch2 names its implementation files .cpp.
As a consequence, we simplified the creation of doctest with main.
Extra file doctest_main.cpp is not needed.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a44f6a2d..10dffa67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Consider opening an issue for a discussion before making a pull request to make 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 - 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. +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.cpp``` - 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**](doc/markdown/features.md) page. |