on master help sign in
Move the README of benchmarks and tests into the developer docs
commit72a0199c676acc5260dccaca89364986f5ea9b2b authorAdithya Kumar <adithya@composewell.com> dateWed 30 Mar 2022, 03:48 (5 years ago) parent0c02fea
4 files changed+7−5
benchmark/README.md → docs/Developer/Benchmarks.md docs/Developer/Contributing.md+5−5 test/README.md → docs/Developer/Tests.md streamly.cabal+2
benchmark/README.md → docs/Developer/Benchmarks.mdrenamed

The content is the same.

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

The content is the same.

streamly.cabal+2
@@ -220,6 +220,7 @@ extra-doc-files:
220220 CHANGELOG.md
221221 README.md
222222 benchmark/README.md
223+ docs/Developer/Benchmarks.md
223224 docs/Developer/*.png
224225 docs/Developer/*.md
225226 docs/Developer/*.rst
@@ -236,6 +237,7 @@ extra-doc-files:
236237 docs/ProjectRelated/Roadmap.link
237238 docs/ProjectRelated/API-changelog.txt
238239 test/README.md
240+ docs/Developer/Tests.md
239241
240242extra-tmp-files:
241243 config.log