Skip to content

Commit ce4d3e5

Browse files
committed
Update name of default branch to main
1 parent 7f29f8d commit ce4d3e5

File tree

9 files changed

+21
-21
lines changed

9 files changed

+21
-21
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Description
22

33
## Checklist
4-
- [ ] Follow the [Contributor Guidelines](https://github.com/skypyproject/skypy/blob/master/CONTRIBUTING.md)
4+
- [ ] Follow the [Contributor Guidelines](https://github.com/skypyproject/skypy/blob/main/CONTRIBUTING.rst)
55
- [ ] Write unit tests
66
- [ ] Write documentation strings
77
- [ ] Assign someone from your working team to review this pull request

.github/workflows/codestyle.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ name: Code Style
22
on:
33
push:
44
branches:
5-
- master
5+
- main
66
- module/*
77
pull_request:
88
branches:
9-
- master
9+
- main
1010
- module/*
1111
jobs:
1212
flake8:

.github/workflows/compatibility.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ jobs:
1111
os: [ubuntu-latest]
1212
python: [3.9]
1313
toxenv: [py39-test, py39-test-dev]
14-
release: [master, latest]
14+
release: [main, latest]
1515
steps:
1616
- name: Checkout Repository
1717
uses: actions/checkout@v2
1818
with:
1919
fetch-depth: 0
20-
- if: matrix.release != 'master'
20+
- if: matrix.release != 'main'
2121
name: Checkout Release
2222
run: |
2323
git checkout tags/$(curl -s https://api.github.com/repos/skypyproject/skypy/releases/${{ matrix.release }} | python -c "import sys, json; print(json.load(sys.stdin)['tag_name'])")

.github/workflows/tests.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ name: Tests
22
on:
33
push:
44
branches:
5-
- master
5+
- main
66
- module/*
77
pull_request:
88
branches:
9-
- master
9+
- main
1010
- module/*
1111
jobs:
1212
test:

CONTRIBUTING.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Finally add the ``skypyproject`` repository as a *remote*. This will allow you t
3232
Create a branch for your new feature
3333
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3434

35-
Create a *branch* off the ``skypyproject`` master branch. Working on unique branches for each new feature simplifies the development, review and merge processes by maintining logical separation. To create a feature branch:
35+
Create a *branch* off the ``skypyproject`` main branch. Working on unique branches for each new feature simplifies the development, review and merge processes by maintining logical separation. To create a feature branch:
3636

3737
::
3838

3939
git fetch skypyproject
40-
git checkout -b <your-branch-name> skypyproject/master
40+
git checkout -b <your-branch-name> skypyproject/main
4141

4242

4343
Hack away!
@@ -73,7 +73,7 @@ When you feel that work on your new feature is complete, you should create a *Pu
7373
1. Go to `SkyPy Pull Requests <https://github.com/skypyproject/skypy/pulls>`_
7474
2. Click the green **New pull request** button
7575
3. Click **compare across forks**
76-
4. Confirm that the base fork is ``skypyproject/skypy`` and the base branch is ``master``
76+
4. Confirm that the base fork is ``skypyproject/skypy`` and the base branch is ``main``
7777
5. Confirm the head fork is ``<your-account>/skypy`` and the compare branch is ``<your-branch-name>``
7878
6. Give your pull request a title and fill out the the template for the description
7979
7. Click the green **Create pull request** button
@@ -91,22 +91,22 @@ A series of automated checks will be run on your pull request, some of which wil
9191
Updating your branch
9292
^^^^^^^^^^^^^^^^^^^^
9393

94-
As you work on your feature, new commits might be made to the ``skypyproject`` master branch. You will need to update your branch with these new commits before your pull request can be accepted. You can achieve this in a few different ways:
94+
As you work on your feature, new commits might be made to the ``skypyproject`` main branch. You will need to update your branch with these new commits before your pull request can be accepted. You can achieve this in a few different ways:
9595

9696
- If your pull request has no conflicts, click **Update branch**
9797
- If your pull request has conflicts, click **Resolve conflicts**, manually resolve the conflicts and click **Mark as resolved**
98-
- *merge* the ``skypyproject`` master branch from the command line:
98+
- *merge* the ``skypyproject`` main branch from the command line:
9999

100100
::
101101

102102
git fetch skypyproject
103-
git merge skypyproject/master
103+
git merge skypyproject/main
104104

105-
- *rebase* your feature branch onto the ``skypyproject`` master branch from the command line:
105+
- *rebase* your feature branch onto the ``skypyproject`` main branch from the command line:
106106
::
107107

108108
git fetch skypyproject
109-
git rebase skypyproject/master
109+
git rebase skypyproject/main
110110

111111

112112
**Warning**: It is bad practice to *rebase* commits that have already been pushed to a remote such as your fork. Rebasing creates new copies of your commits that can cause the local and remote branches to diverge. ``git push --force`` will **overwrite** the remote branch with your newly rebased local branch. This is strongly discouraged, particularly when working on a shared branch where you could erase a collaborators commits.
@@ -129,7 +129,7 @@ Before your pull request can be merged into the codebase, it will be reviewed by
129129
General Guidelines
130130
^^^^^^^^^^^^^^^^^^
131131

132-
- SkyPy is compatible with Python>=3.6 (see `setup.cfg <https://github.com/skypyproject/skypy/blob/master/setup.cfg>`_). SkyPy *does not* support backwards compatibility with Python 2.x; `six`, `__future__` and `2to3` should not be used.
132+
- SkyPy is compatible with Python>=3.6 (see `setup.cfg <https://github.com/skypyproject/skypy/blob/main/setup.cfg>`_). SkyPy *does not* support backwards compatibility with Python 2.x; `six`, `__future__` and `2to3` should not be used.
133133
- All contributions should follow the `PEP8 Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_. We recommend using `flake8 <https://flake8.pycqa.org/>`__ to check your code for PEP8 compliance.
134134
- Importing SkyPy should only depend on having `NumPy <https://www.numpy.org>`_, `SciPy <https://www.scipy.org/>`_ and `Astropy <https://www.astropy.org/>`__ installed.
135135
- Code is grouped into submodules based on broad science areas e.g. `galaxies <https://skypy.readthedocs.io/en/stable/galaxies.html>`_. There is also a `utils <https://skypy.readthedocs.io/en/stable/utils/index.html>`_ submodule for general utility functions.

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ in the `Code of Conduct`_.
6767
.. |GitHub| image:: https://github.com/skypyproject/skypy/workflows/Tests/badge.svg
6868
:target: https://github.com/skypyproject/skypy/actions
6969

70-
.. |Codecov| image:: https://codecov.io/gh/skypyproject/skypy/branch/master/graph/badge.svg
70+
.. |Codecov| image:: https://codecov.io/gh/skypyproject/skypy/branch/main/graph/badge.svg
7171
:target: https://codecov.io/gh/skypyproject/skypy
7272

7373
.. |Zenodo| image:: https://zenodo.org/badge/221432358.svg

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
extensions += ['sphinx_astropy.ext.edit_on_github']
166166

167167
edit_on_github_project = setup_cfg['github_project']
168-
edit_on_github_branch = "master"
168+
edit_on_github_branch = "main"
169169

170170
edit_on_github_source_root = ""
171171
edit_on_github_doc_root = "docs"

docs/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ channel. To install the latest version for your active conda environment:
2929
From GitHub
3030
-----------
3131

32-
The latest development version of SkyPy can be found on the master branch of
32+
The latest development version of SkyPy can be found on the main branch of
3333
the `skypyproject/skypy`_ GitHub repository. This and any other branch or tag
3434
can be installed directly from GitHub using a recent version of pip:
3535

3636
.. code:: console
3737
38-
$ pip install skypy@git+https://github.com/skypyproject/skypy.git@master
38+
$ pip install skypy@git+https://github.com/skypyproject/skypy.git@main
3939
4040
Dependencies
4141
------------

skypy/pipeline/_pipeline.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def __init__(self, configuration):
6565
6666
References
6767
----------
68-
.. [1] https://github.com/skypyproject/skypy/tree/master/examples
68+
.. [1] https://github.com/skypyproject/skypy/tree/main/examples
6969
7070
'''
7171

0 commit comments

Comments
 (0)