Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Description

## Checklist
- [ ] Follow the [Contributor Guidelines](https://github.com/skypyproject/skypy/blob/master/CONTRIBUTING.md)
- [ ] Follow the [Contributor Guidelines](https://github.com/skypyproject/skypy/blob/main/CONTRIBUTING.rst)
- [ ] Write unit tests
- [ ] Write documentation strings
- [ ] Assign someone from your working team to review this pull request
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/codestyle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ name: Code Style
on:
push:
branches:
- master
- main
- module/*
pull_request:
branches:
- master
- main
- module/*
jobs:
flake8:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/compatibility.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ jobs:
os: [ubuntu-latest]
python: [3.9]
toxenv: [py39-test, py39-test-dev]
release: [master, latest]
release: [main, latest]
steps:
- name: Checkout Repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- if: matrix.release != 'master'
- if: matrix.release != 'main'
name: Checkout Release
run: |
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'])")
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ name: Tests
on:
push:
branches:
- master
- main
- module/*
pull_request:
branches:
- master
- main
- module/*
jobs:
test:
Expand Down
18 changes: 9 additions & 9 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ Finally add the ``skypyproject`` repository as a *remote*. This will allow you t
Create a branch for your new feature
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
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:

::

git fetch skypyproject
git checkout -b <your-branch-name> skypyproject/master
git checkout -b <your-branch-name> skypyproject/main


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

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:
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:

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

::

git fetch skypyproject
git merge skypyproject/master
git merge skypyproject/main

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

git fetch skypyproject
git rebase skypyproject/master
git rebase skypyproject/main


**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.
Expand All @@ -129,7 +129,7 @@ Before your pull request can be merged into the codebase, it will be reviewed by
General Guidelines
^^^^^^^^^^^^^^^^^^

- 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.
- 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.
- 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.
- Importing SkyPy should only depend on having `NumPy <https://www.numpy.org>`_, `SciPy <https://www.scipy.org/>`_ and `Astropy <https://www.astropy.org/>`__ installed.
- 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.
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ in the `Code of Conduct`_.
.. |GitHub| image:: https://github.com/skypyproject/skypy/workflows/Tests/badge.svg
:target: https://github.com/skypyproject/skypy/actions

.. |Codecov| image:: https://codecov.io/gh/skypyproject/skypy/branch/master/graph/badge.svg
.. |Codecov| image:: https://codecov.io/gh/skypyproject/skypy/branch/main/graph/badge.svg
:target: https://codecov.io/gh/skypyproject/skypy

.. |Zenodo| image:: https://zenodo.org/badge/221432358.svg
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
extensions += ['sphinx_astropy.ext.edit_on_github']

edit_on_github_project = setup_cfg['github_project']
edit_on_github_branch = "master"
edit_on_github_branch = "main"

edit_on_github_source_root = ""
edit_on_github_doc_root = "docs"
Expand Down
4 changes: 2 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ channel. To install the latest version for your active conda environment:
From GitHub
-----------

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

.. code:: console

$ pip install skypy@git+https://github.com/skypyproject/skypy.git@master
$ pip install skypy@git+https://github.com/skypyproject/skypy.git@main

Dependencies
------------
Expand Down
2 changes: 1 addition & 1 deletion skypy/pipeline/_pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def __init__(self, configuration):

References
----------
.. [1] https://github.com/skypyproject/skypy/tree/master/examples
.. [1] https://github.com/skypyproject/skypy/tree/main/examples

'''

Expand Down