composewell/streamly
1
1
Fork 0
mirror of https://github.com/composewell/streamly.git synced 2024-09-11 11:37:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Move the README of benchmarks and tests into the developer docs

Browse Source
This commit is contained in:
Adithya Kumar 2022-03-30 03:48:14 +05:30
parent 0c02feae1f
commit 72a0199c67
4 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
benchmark/README.md → docs/Developer/Benchmarks.md
View File

10
docs/Developer/Contributing.md
View File

@ -34,8 +34,8 @@ The `bin/test.sh` and `bin/bench.sh` are custom scripts to perform test
and benchmarking tasks conveniently. They support running a group of
tests or benchmarks, coverage, using correct optimization flags for
benchmarking, benchmark comparison reports etc. Use the `--help` option
to see how to use these. See [benchmark/README.md](/benchmark/README.md)
and [test/README.md](/test/README.md) for more details.
to see how to use these. See [benchmark/README.md](/docs/Developer/Benchmarks.md)
and [test/README.md](/docs/Developer/Tests.md) for more details.
You can also run tests or benchmarks directly for example:
@ -88,7 +88,7 @@ Here is a quick checklist for a PR, for details please see the next section:
* Tests are added to cover the changed parts
* All [tests](/test) pass
* [Performance benchmarks](/benchmark) are added, where applicable
* No significant regressions are reported by [performance benchmarks](/benchmark/README.md)
* No significant regressions are reported by [performance benchmarks](/docs/Developer/Benchmarks.md)
* Haddock documentation is added to user visible APIs and data types
* Tutorial module, [Introduction](/docs/Tutorials/Introduction.md), and [guides](/docs) are
updated if necessary.
@ -146,7 +146,7 @@ BRANCH.
It is a good idea to include tests for the changes where applicable. See
the existing tests in the [test](/test) directory. Also see the
[test/README.md](/test/README.md) for more details on how to run the tests.
[test/README.md](/docs/Developer/Tests.md) for more details on how to run the tests.
### Documentation
@ -163,7 +163,7 @@ any of the existing performance benchmarks. If you introduced something new
then you may want to add benchmarks to check if it performs as well as expected
by the programmers to deem it usable.
See the [README](/benchmark/README.md) file in the `benchmark` directory for more
See the [README](/docs/Developer/Benchmarks.md) file in the `benchmark` directory for more
details on how to run the benchmarks.
The first level of check is the regression in "allocations", this is

0
test/README.md → docs/Developer/Tests.md
View File

2
streamly.cabal
View File

@ -220,6 +220,7 @@ extra-doc-files:
CHANGELOG.md
README.md
benchmark/README.md
docs/Developer/Benchmarks.md
docs/Developer/*.png
docs/Developer/*.md
docs/Developer/*.rst
@ -236,6 +237,7 @@ extra-doc-files:
docs/ProjectRelated/Roadmap.link
docs/ProjectRelated/API-changelog.txt
test/README.md
docs/Developer/Tests.md
extra-tmp-files:
config.log