on master help sign in
Move the README of benchmarks and tests into the developer docs
72a0199Adithya Kumar
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
34and benchmarking tasks conveniently. They support running a group of
34and benchmarking tasks conveniently. They support running a group of
35tests or benchmarks, coverage, using correct optimization flags for
35tests or benchmarks, coverage, using correct optimization flags for
36benchmarking, benchmark comparison reports etc. Use the `--help` option
36benchmarking, benchmark comparison reports etc. Use the `--help` option
37−to see how to use these. See [benchmark/README.md](/benchmark/README.md)
37+to see how to use these. See [benchmark/README.md](/docs/Developer/Benchmarks.md)
38−and [test/README.md](/test/README.md) for more details.
38+and [test/README.md](/docs/Developer/Tests.md) for more details.
39
39
40You can also run tests or benchmarks directly for example:
40You can also run tests or benchmarks directly for example:
41
41
@@ -88,7 +88,7 @@ Here is a quick checklist for a PR, for details please see the next section:
88* Tests are added to cover the changed parts
88* Tests are added to cover the changed parts
89* All [tests](/test) pass
89* All [tests](/test) pass
90* [Performance benchmarks](/benchmark) are added, where applicable
90* [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)
92* Haddock documentation is added to user visible APIs and data types
92* Haddock documentation is added to user visible APIs and data types
93* Tutorial module, [Introduction](/docs/Tutorials/Introduction.md), and [guides](/docs) are
93* Tutorial module, [Introduction](/docs/Tutorials/Introduction.md), and [guides](/docs) are
94 updated if necessary.
94 updated if necessary.
@@ -146,7 +146,7 @@ BRANCH.
146
146
147It is a good idea to include tests for the changes where applicable. See
147It is a good idea to include tests for the changes where applicable. See
148the existing tests in the [test](/test) directory. Also see the
148the 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.
150
150
151### Documentation
151### Documentation
152
152
@@ -163,7 +163,7 @@ any of the existing performance benchmarks. If you introduced something new
163then you may want to add benchmarks to check if it performs as well as expected
163then you may want to add benchmarks to check if it performs as well as expected
164by the programmers to deem it usable.
164by the programmers to deem it usable.
165
165
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
167details on how to run the benchmarks.
167details on how to run the benchmarks.
168
168
169The first level of check is the regression in "allocations", this is
169The 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:
220 CHANGELOG.md
220 CHANGELOG.md
221 README.md
221 README.md
222 benchmark/README.md
222 benchmark/README.md
223+ docs/Developer/Benchmarks.md
223 docs/Developer/*.png
224 docs/Developer/*.png
224 docs/Developer/*.md
225 docs/Developer/*.md
225 docs/Developer/*.rst
226 docs/Developer/*.rst
@@ -236,6 +237,7 @@ extra-doc-files:
236 docs/ProjectRelated/Roadmap.link
237 docs/ProjectRelated/Roadmap.link
237 docs/ProjectRelated/API-changelog.txt
238 docs/ProjectRelated/API-changelog.txt
238 test/README.md
239 test/README.md
240+ docs/Developer/Tests.md
239
241
240extra-tmp-files:
242extra-tmp-files:
241 config.log
243 config.log