You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reformat miscellaneous .md files outside of docs/ (#6999)
* Reformat & mildly edit CONTRIBUTING.md
1) Reformat to follow Google Markdown style guidelines.
2) Make very small edits in a few places for clarification and
consistency.
* Reformat & edit release.md
1) Reformat to follow Google Markdown style guidelines.
2) Edit the text for (hopefully) improved clarity.
3) Fix minor typos.
* Reformat md -- no content change
Reformatted using markdownlint.
* Reformat md & make trivial edit
Reformatted using markdownlint, and made a minor edit to the first
sentence.
* Reformat md and add a link
* Reformat and make corrections & edits
* Reformat md
* Reformat md to following Google Markdown style
Ran files through markdownlint and manually corrected some things.
* Delete trailing whitespace
Per comment by @Pavol at #6999 (review)
* Use a more descriptive title
Per suggestion by @Pavol at #6999 (comment)
The benchmark files (`bench_*.py`) stored in the current package (`benchmarks/*`) are used by asv to run benchmark tests for Cirq. For more information on how to write new benchmarks, please refer [Writing benchmarks guide by ASV](https://asv.readthedocs.io/en/stable/writing_benchmarks.html)
7
+
8
+
The benchmark files (`bench_*.py`) stored in the current package
9
+
(`benchmarks/*`) are used by ASV to run benchmark tests for Cirq. For more
10
+
information on how to write new benchmarks, please refer [Writing benchmarks
11
+
guide by ASV](https://asv.readthedocs.io/en/stable/writing_benchmarks.html)
6
12
7
13
## Usage
8
-
To run all benchmarks, navigate to the root Cirq directory at the command line and execute
14
+
15
+
To run all benchmarks, navigate to the root Cirq directory at the command line
16
+
and execute the following command:
9
17
10
18
```bash
11
19
./check/asv_run
12
20
```
13
21
14
-
You can also pass arguments to the script, which would be forwarded to the `asv run` command. For eg:
22
+
You can also pass arguments to the `asv_run` script, which will be forwarded to
The `cirq-google` directory should abide by Semantic Versioning 2.0.0. In rare cases, we may introduce backward-incompatible changes to the public API in a release with a minor version increment. Such changes will be noted in `CHANGELOG.md` within the directory before the release.
3
+
The `cirq-google` directory should abide by the [Semantic Versioning
4
+
2.0.0](https://semver.org/) principles. In rare cases, we may introduce
5
+
backward-incompatible changes to the public API in a release with a minor
6
+
version increment. Such changes will be noted in `CHANGELOG.md` within the
0 commit comments