Skip to content

Commit dbbca73

Browse files
authoredDec 1, 2023
Change master to main in documentation (#6365)
- We are changing the default branch from master to main in order to conform to best practices and remove problematic terminology. - This PR changes references in documentation (mostly links) to use main.
1 parent ced1383 commit dbbca73

File tree

74 files changed

+215
-215
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+215
-215
lines changed
 

‎CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,27 @@ Forking creates a new github repo at the location
3838
your github id. Use the directions on the
3939
[development page](docs/dev/development.md) to download a copy to
4040
your local machine. You need only do this once.
41-
1. Checkout master and create a new branch from this master
41+
1. Checkout main and create a new branch from this main
4242
```shell
43-
git checkout master -b new_branch_name
43+
git checkout main -b new_branch_name
4444
```
4545
where ```new_branch_name``` is the name of your new branch.
4646
1. Do your work and commit your changes to this branch.
47-
1. If you have drifted out of sync with the master from the
47+
1. If you have drifted out of sync with the main from the
4848
main cirq repo you may need to merge in changes. To do this,
49-
first update your local master and then merge the local master
49+
first update your local main and then merge the local main
5050
into your branch:
5151
```shell
5252
# Track the upstream repo (if your local repo hasn't):
5353
git remote add upstream https://github.com/quantumlib/Cirq.git
5454
55-
# Update your local master.
55+
# Update your local main.
5656
git fetch upstream
57-
git checkout master
58-
git merge upstream/master
59-
# Merge local master into your branch.
57+
git checkout main
58+
git merge upstream/main
59+
# Merge local main into your branch.
6060
git checkout new_branch_name
61-
git merge master
61+
git merge main
6262
```
6363
You may need to fix merge conflicts for both of these merge
6464
commands.

‎README.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/Cirq_logo_color.png
1+
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png
22
:target: https://github.com/quantumlib/cirq
33
:alt: Cirq
44
:width: 500px
@@ -10,7 +10,7 @@ circuits and running them against quantum computers and simulators.
1010
:target: https://github.com/quantumlib/Cirq
1111
:alt: Build Status
1212

13-
.. image:: https://codecov.io/gh/quantumlib/Cirq/branch/master/graph/badge.svg
13+
.. image:: https://codecov.io/gh/quantumlib/Cirq/branch/main/graph/badge.svg
1414
:target: https://codecov.io/gh/quantumlib/Cirq
1515

1616
.. image:: https://badge.fury.io/py/cirq.svg
@@ -26,7 +26,7 @@ Installation and Documentation
2626

2727
Cirq documentation is available at `quantumai.google/cirq <https://quantumai.google/cirq>`_.
2828

29-
Documentation for the latest **pre-release** version of cirq (tracks the repository's master branch; what you get if you ``pip install --pre cirq``), is available `here <https://quantumai.google/reference/python/cirq/all_symbols?version=nightly>`__.
29+
Documentation for the latest **pre-release** version of cirq (tracks the repository's main branch; what you get if you ``pip install --pre cirq``), is available `here <https://quantumai.google/reference/python/cirq/all_symbols?version=nightly>`__.
3030

3131
Documentation for the latest **stable** version of cirq (what you get if you ``pip install cirq``) is available `here <https://quantumai.google/reference/python/cirq/all_symbols>`__.
3232

@@ -98,10 +98,10 @@ Cirq Contributors Community
9898
---------------------------
9999

100100
We welcome contributions! Before opening your first PR, a good place to start is to read our
101-
`guidelines <https://github.com/quantumlib/cirq/blob/master/CONTRIBUTING.md>`__.
101+
`guidelines <https://github.com/quantumlib/cirq/blob/main/CONTRIBUTING.md>`__.
102102

103103
We are dedicated to cultivating an open and inclusive community to build software for near term quantum computers.
104-
Please read our `code of conduct <https://github.com/quantumlib/cirq/blob/master/CODE_OF_CONDUCT.md>`__ for the rules of engagement within our community.
104+
Please read our `code of conduct <https://github.com/quantumlib/cirq/blob/main/CODE_OF_CONDUCT.md>`__ for the rules of engagement within our community.
105105

106106
For real time informal discussions about Cirq, join our `cirqdev <https://gitter.im/cirqdev/community>`__ Gitter channel, come hangout with us!
107107

0 commit comments

Comments
 (0)
Please sign in to comment.