boost/histogram
2
0
Fork 0
mirror of https://github.com/boostorg/histogram.git synced 2026-01-19 04:12:12 +00:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Hans Dembinski
2022-12-23 11:58:59 +01:00
committed by GitHub
parent c5905d8827
commit a1aa92deab
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md
View File

@@ -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. 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. 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! 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 ## 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. 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). 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 ### 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. To make the tests complete faster, you can use the option `-j4` (or another number) to build in parallel.
#### Generate documentation ### With b2filt
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
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: 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 ```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. 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 ### Check test coverage
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
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`. 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. 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 ## Coding Style
Follow the [Boost Library Requirements and Guidelines](https://www.boost.org/development/requirements.html) and the established style in Boost.Histogram. Follow the [Boost Library Requirements and Guidelines](https://www.boost.org/development/requirements.html) and the established style in Boost.Histogram.