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
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,12 +32,12 @@ Finally add the ``skypyproject`` repository as a *remote*. This will allow you t
32
32
Create a branch for your new feature
33
33
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
34
34
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:
@@ -73,7 +73,7 @@ When you feel that work on your new feature is complete, you should create a *Pu
73
73
1. Go to `SkyPy Pull Requests <https://github.com/skypyproject/skypy/pulls>`_
74
74
2. Click the green **New pull request** button
75
75
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``
77
77
5. Confirm the head fork is ``<your-account>/skypy`` and the compare branch is ``<your-branch-name>``
78
78
6. Give your pull request a title and fill out the the template for the description
79
79
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
91
91
Updating your branch
92
92
^^^^^^^^^^^^^^^^^^^^
93
93
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:
95
95
96
96
- If your pull request has no conflicts, click **Update branch**
97
97
- 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:
99
99
100
100
::
101
101
102
102
git fetch skypyproject
103
-
git merge skypyproject/master
103
+
git merge skypyproject/main
104
104
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:
106
106
::
107
107
108
108
git fetch skypyproject
109
-
git rebase skypyproject/master
109
+
git rebase skypyproject/main
110
110
111
111
112
112
**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
129
129
General Guidelines
130
130
^^^^^^^^^^^^^^^^^^
131
131
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.
133
133
- 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.
134
134
- Importing SkyPy should only depend on having `NumPy <https://www.numpy.org>`_, `SciPy <https://www.scipy.org/>`_ and `Astropy <https://www.astropy.org/>`__ installed.
135
135
- 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.
0 commit comments