Skip to content

Commit eb791d3

Browse files
feat(HdrHistogram#66): Document Unit Tests and Benchmarks (HdrHistogram#123)
* plan(HdrHistogram#66): initial brief from issue * plan(HdrHistogram#66): review brief * plan(HdrHistogram#66): create task breakdown * feat(HdrHistogram#66): implement tasks * feat(HdrHistogram#66): complete implementation
1 parent e098f05 commit eb791d3

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,25 @@ If you do choose to contribute, please first raise an issue so we are not caught
261261
Next can you please ensure that your PR (Pull Request) has a comment in it describing what it achieves and the issues that it closes.
262262
Ideally if it is fixing an issue or a bug, there would be a Unit Test proving the fix and a reference to the Issues in the PR comments.
263263

264+
## Development
265+
266+
### Running the Tests
267+
268+
The unit tests can be run using `dotnet test`.
269+
270+
```sh
271+
dotnet test ./HdrHistogram.UnitTests/HdrHistogram.UnitTests.csproj -v q -c Release
272+
```
273+
274+
### Running the Benchmarks
275+
276+
The benchmarks are run using `dotnet run` in Release mode.
277+
A full benchmark run may take several minutes.
278+
279+
```sh
280+
dotnet run -c Release --project ./HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj
281+
```
282+
264283
---
265284

266285
## HdrHistogram Details

0 commit comments

Comments
 (0)