Skip to content

Commit 42927b8

Browse files
authoredMar 20, 2024··
Fix capitalization of GitHub in docs (#6509)
- Saw an old PR to replace Github with proper capitalization of GitHub. - This PR does this on a more consistent basis and updates that PR. - Replaces #5961
1 parent a2425eb commit 42927b8

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed
 

‎.zenodo.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@
99
}
1010
],
1111
"access_right": "open",
12-
"notes": "See full list of authors on Github: https://github.com/quantumlib/Cirq/graphs/contributors"
13-
}
12+
"notes": "See full list of authors on GitHub: https://github.com/quantumlib/Cirq/graphs/contributors"
13+
}

‎README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Example output:
7575
Feature requests / Bugs / Questions
7676
-----------------------------------
7777

78-
If you have feature requests or you found a bug, please `file them on Github <https://github.com/quantumlib/Cirq/issues/new/choose>`__.
78+
If you have feature requests or you found a bug, please `file them on GitHub <https://github.com/quantumlib/Cirq/issues/new/choose>`__.
7979

8080
For questions about how to use Cirq post to
8181
`Quantum Computing Stack Exchange <https://quantumcomputing.stackexchange.com/>`__ with the

‎dev_tools/notebooks/notebook_test.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ def test_notebooks_against_cirq_head(
124124
print(result.stderr)
125125
pytest.fail(
126126
f"Notebook failure: {notebook_file}, please see {out_path} for the output "
127-
f"notebook (in Github Actions, you can download it from the workflow artifact"
127+
f"notebook (in GitHub Actions, you can download it from the workflow artifact"
128128
f" 'notebook-outputs')"
129129
)
130130
os.remove(rewritten_notebook_path)

‎docs/dev/rfc_process.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following are NOT major features:
2626
* Fixing a bug.
2727
* Extending the functionality of an existing method in a natural way.
2828

29-
If you are not sure if a feature constitute as a “major feature”, just submit a Github issue with a description,
29+
If you are not sure if a feature constitute as a “major feature”, just submit a GitHub issue with a description,
3030
and one of the maintainers will flag the issue as a major feature if necessary.
3131

3232
## How to submit an RFC
@@ -37,12 +37,12 @@ Open a [feature request](https://github.com/quantumlib/Cirq/issues/new?assignees
3737
and have a discussion with the maintainers. Mention that you are willing to write an RFC.
3838
2. [Join the cirq-dev Google Group](https://groups.google.com/forum/#!forum/cirq-dev) to get an invitation to our weekly Cirq Cynq meeting.
3939
3. Draft your RFC.
40-
* Follow the [RFC template](https://tinyurl.com/cirq-rfc-template), link the Github issue in your RFC.
40+
* Follow the [RFC template](https://tinyurl.com/cirq-rfc-template), link the GitHub issue in your RFC.
4141
* Make sure to share your doc with cirq-dev@googlegroups.com for comments.
4242
* Link the RFC in your issue.
4343
4. Recruiting a sponsor:
4444
* A sponsor must be a maintainer of the project or the product manager.
45-
* Write a comment in your Github issue that calls out that you are "Looking for a sponsor". A maintainer will mark the issue with a label: "rfc/needs-sponsor".
45+
* Write a comment in your GitHub issue that calls out that you are "Looking for a sponsor". A maintainer will mark the issue with a label: "rfc/needs-sponsor".
4646
* While it might take some time to get a maintainer to sponsor your RFC, it is essential, as the sponsor will facilitate the process for reviewing your design.
4747
* Tips to recruit a sponsor: 1) keep commenting on the issue weekly 2) attend Cirq Cynq and push for a sponsor.
4848
5. Agree with your sponsor on a Cirq Cync meeting to present the RFC so that other contributors and maintainers can become more familiar with your design.

‎docs/dev/triage.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ The goals for this document are as follows:
1010

1111
* provide visibility for project and release status
1212

13-
## Automation: Triage party and Github Actions
13+
## Automation: Triage party and GitHub Actions
1414

1515
[Triage Party](https://github.com/google/triage-party) is a stateless web app to optimize issue and PR triage for large open-source projects using the GitHub API.
1616

1717
Our deployed version is here (a static IP, domain request is in progress): [http://bit.do/cirq-triage-party](http://bit.do/cirq-triage-party)
1818

19-
[Github Actions](https://github.com/features/actions) is Github's workflow automation platform. We use it for continuous integration testing as well as for stale issue handling later described here.
19+
[GitHub Actions](https://github.com/features/actions) is GitHub's workflow automation platform. We use it for continuous integration testing as well as for stale issue handling later described here.
2020

2121
## Issue states and labels
2222

@@ -55,7 +55,7 @@ Triage states are
5555
* `triage/needs-reproduction` - for bugs only
5656
* `triage/needs-feasibility` - for feature requests (maybe bugs).
5757
* `triage/needs-more-evidence` - for feature requests - the feature request seems plausible but we need more understanding if it is valuable for enough users to warrant implementing and maintaining it.
58-
* `triage/stale` - Github actions automatically marks some of the issues stale and then it closes them in case of 30 days of inactivity.
58+
* `triage/stale` - GitHub actions automatically marks some of the issues stale and then it closes them in case of 30 days of inactivity.
5959
* `triage/duplicate` - we mark duplicated issues with this label.
6060

6161
While these are fairly straightforward and intuitive the workflows are depicted below.
@@ -156,7 +156,7 @@ To summarize, **all issues** are subject to staleness-check, **except** the foll
156156
* `kind/roadmap-item`
157157
* `kind/task`
158158

159-
The staleness check automation is implemented via Github Actions, the latest definition of staleness is defined in [our staleness Github Action workflow](https://github.com/quantumlib/Cirq/blob/main/.github/workflows/stale.yml).
159+
The staleness check automation is implemented via GitHub Actions, the latest definition of staleness is defined in [our staleness GitHub Action workflow](https://github.com/quantumlib/Cirq/blob/main/.github/workflows/stale.yml).
160160

161161

162162
## Processes
@@ -170,7 +170,7 @@ The staleness check automation is implemented via Github Actions, the latest def
170170
- maintain a backlog that makes it easy to match contributors as well as maintainers to work items.
171171
- for pull requests we are aiming for
172172
* **responsiveness** - people can get their work done - we don't want to block community / our team members.
173-
* **clean workspace** - stale PRs are wasteful as clutter is cognitive cost for maintainers. Stale PRs also a resource cost on Github - eating into other contributors' capacity to execute Github Actions / checks.
173+
* **clean workspace** - stale PRs are wasteful as clutter is cognitive cost for maintainers. Stale PRs also a resource cost on GitHub - eating into other contributors' capacity to execute GitHub Actions / checks.
174174

175175
**Who**
176176

‎docs/experiments/_index.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ landing_page:
55
nav: left
66
rows:
77
- heading: Experiments using quantum circuits
8-
description: This is a collection of algorithms and experiments written in and using Cirq. A couple of them use only base Cirq, but the rest use additional code stored in ReCirq, a Github repository for research code that uses and builds upon Cirq.
8+
description: This is a collection of algorithms and experiments written in and using Cirq. A couple of them use only base Cirq, but the rest use additional code stored in ReCirq, a GitHub repository for research code that uses and builds upon Cirq.
99
- buttons:
10-
- label: Cirq Github
10+
- label: Cirq GitHub
1111
path: https://github.com/quantumlib/Cirq
12-
- label: ReCirq Github
12+
- label: ReCirq GitHub
1313
path: https://github.com/quantumlib/ReCirq
1414
- heading: Algorithms in base Cirq
1515
description: Algorithms and experiments executable using only default Cirq code.

‎docs/simulate/virtual_engine_interface.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
"\n",
126126
"The easiest way to create a `cirq_google.SimulatedLocalEngine` is to make one from one or more processor templates. \n",
127127
"Example processor device specifications can be found in \n",
128-
"the [devices/specifications](https://github.com/quantumlib/Cirq/tree/main/cirq-google/cirq_google/devices/specifications) folder of `cirq_google` in the Cirq Github repository. These device specifications closely match previous versions of Google quantum hardware, and can serve as templates for processors in a `SimulatedLocalEngine`. When Google hardware becomes publicly available again in the future, it will have device specifications like these that differ in details, but not in format.\n",
128+
"the [devices/specifications](https://github.com/quantumlib/Cirq/tree/main/cirq-google/cirq_google/devices/specifications) folder of `cirq_google` in the Cirq GitHub repository. These device specifications closely match previous versions of Google quantum hardware, and can serve as templates for processors in a `SimulatedLocalEngine`. When Google hardware becomes publicly available again in the future, it will have device specifications like these that differ in details, but not in format.\n",
129129
"\n",
130130
"You can create a `cirq_google.SimulatedLocalEngine` that includes these example device specifications using `cirq_google.engine.create_noiseless_virtual_engine_from_latest_templates()`. For example:"
131131
]

0 commit comments

Comments
 (0)
Please sign in to comment.