From a1aa92deab34206fa1f0f68fe7bcd41e07104954 Mon Sep 17 00:00:00 2001 From: Hans Dembinski Date: Fri, 23 Dec 2022 11:58:59 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef153c33..83c9e60b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ If you like Boost.Histogram, please star the project on Github! We want Boost.Hi Feel free to ask questions on https://gitter.im/boostorg/histogram. -## Reporting Issues +## Reporting issues We value your feedback about issues you encounter. The more information you provide the easier it is for developers to resolve the problem. @@ -19,13 +19,20 @@ Issues can also be used to submit feature requests. Don't be shy: if you are friendly, we are friendly! +### Reporting failures + +Please report any tests failures to the issue tracker along with the test output and information on your system: + +* platform (Linux, Windows, OSX, ...) +* compiler and version + ## Submitting Pull Requests Fork the main repository. Base your changes on the `develop` branch. Make a new branch for any feature or bug-fix in your fork. Start developing. You can start a pull request when you feel the change is ready for review. Please rebase your branch to the original `develop` branch before submitting (which may have diverged from your fork in the meantime). -## Running Tests +## Running tests ### With cmake @@ -53,11 +60,7 @@ You can also test the examples by executing ``` To make the tests complete faster, you can use the option `-j4` (or another number) to build in parallel. -#### Generate documentation - -To build the documentation, you need to install a few extra things, see [Quickbook documentation](https://www.boost.org/doc/libs/1_74_0/doc/html/quickbook/install.html). - -#### Using b2filt +### With b2filt The output of b2 is verbose and there is no highlighting, so sometimes it is difficult to spot a problem. You can give `b2filt` are try, which you can install with `pip install b2filt`. Just replace `../../b2` with `b2filt`, for example: ```sh @@ -65,14 +68,7 @@ b2filt cxxstd=latest warnings-as-errors=on test ``` Note: b2filt is not an official part of Boost and has never been tested extensively on Windows. Please leave an [issue on GitHub](https://github.com/HDembinski/b2filt) if you have trouble with b2filt. -### Reporting failures - -Please report any tests failures to the issue tracker along with the test output and information on your system: - -* platform (Linux, Windows, OSX, ...) -* compiler and version - -### Test coverage +### Check test coverage Boost.Histogram maintains 100% line coverage. Coverage is automatically checked by CI. To generate a report locally, you need to build the code with gcc-8 or gcc-12 (these version are known to work, others might) and coverage instrumentation enabled, do `b2 toolset=gcc-8 cxxstd=latest coverage=on test`. @@ -82,6 +78,10 @@ This will generate a new folder `coverage-report` with a HTML report. Open `cove Notes: Generating coverage data is very fickle. You need to use gcc-8 or gcc-12 and a matching version of gcov. Other gcc versions were known to be broken or were not supported by lcov at the time of this writing, which is used to process the raw coverage data. Generating coverage data with clang and llvm-cov is not supported by lcov at the ime of this writing. +## Generate documentation + +To build the documentation, you need to install a few extra things, see [Quickbook documentation](https://www.boost.org/doc/libs/1_74_0/doc/html/quickbook/install.html). + ## Coding Style Follow the [Boost Library Requirements and Guidelines](https://www.boost.org/development/requirements.html) and the established style in Boost.Histogram.