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
- 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
Copy file name to clipboardExpand all lines: docs/dev/rfc_process.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ The following are NOT major features:
26
26
* Fixing a bug.
27
27
* Extending the functionality of an existing method in a natural way.
28
28
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,
30
30
and one of the maintainers will flag the issue as a major feature if necessary.
31
31
32
32
## How to submit an RFC
@@ -37,12 +37,12 @@ Open a [feature request](https://github.com/quantumlib/Cirq/issues/new?assignees
37
37
and have a discussion with the maintainers. Mention that you are willing to write an RFC.
38
38
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.
39
39
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.
41
41
* Make sure to share your doc with cirq-dev@googlegroups.com for comments.
42
42
* Link the RFC in your issue.
43
43
4. Recruiting a sponsor:
44
44
* 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".
46
46
* 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.
47
47
* Tips to recruit a sponsor: 1) keep commenting on the issue weekly 2) attend Cirq Cynq and push for a sponsor.
48
48
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.
Copy file name to clipboardExpand all lines: docs/dev/triage.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ The goals for this document are as follows:
10
10
11
11
* provide visibility for project and release status
12
12
13
-
## Automation: Triage party and Github Actions
13
+
## Automation: Triage party and GitHub Actions
14
14
15
15
[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.
16
16
17
17
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)
18
18
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.
20
20
21
21
## Issue states and labels
22
22
@@ -55,7 +55,7 @@ Triage states are
55
55
*`triage/needs-reproduction` - for bugs only
56
56
*`triage/needs-feasibility` - for feature requests (maybe bugs).
57
57
*`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.
59
59
*`triage/duplicate` - we mark duplicated issues with this label.
60
60
61
61
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
156
156
*`kind/roadmap-item`
157
157
*`kind/task`
158
158
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).
160
160
161
161
162
162
## Processes
@@ -170,7 +170,7 @@ The staleness check automation is implemented via Github Actions, the latest def
170
170
- maintain a backlog that makes it easy to match contributors as well as maintainers to work items.
171
171
- for pull requests we are aiming for
172
172
***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.
Copy file name to clipboardExpand all lines: docs/experiments/_index.yaml
+3-3
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,11 @@ landing_page:
5
5
nav: left
6
6
rows:
7
7
- 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.
Copy file name to clipboardExpand all lines: docs/simulate/virtual_engine_interface.ipynb
+1-1
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@
125
125
"\n",
126
126
"The easiest way to create a `cirq_google.SimulatedLocalEngine` is to make one from one or more processor templates. \n",
127
127
"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",
129
129
"\n",
130
130
"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:"
0 commit comments