Skip to content

Commit b212288

Browse files
authored
fix: refresh outdated contributor setup instructions (#638) (#646)
1 parent faacb83 commit b212288

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/contributing.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ reproduces the issue. This is critical for contributors to fix the bug quickly.
3939
If you can figure out how to fix the bug yourself, feel free to submit
4040
a pull request.
4141

42-
.. _contrib_tets:
42+
.. _contrib_tests:
4343

4444
Write tests
4545
===========
@@ -152,7 +152,7 @@ Here is a quick guide for submitting pull requests:
152152
git clone git@github.com:YOUR_GITHUB_USERNAME/ultraplot.git
153153
cd ultraplot
154154
git remote add upstream git@github.com:ultraplot/ultraplot.git
155-
git checkout -b your-branch-name master
155+
git checkout -b your-branch-name main
156156
157157
If you need some help with git, follow the
158158
`quick start guide <https://git.wiki.kernel.org/index.php/QuickStart>`__.
@@ -164,7 +164,7 @@ Here is a quick guide for submitting pull requests:
164164
pip install -e .
165165
166166
This way ``import ultraplot`` imports your local copy,
167-
rather than the stable version you last downloaded from PyPi.
167+
rather than the stable version you last downloaded from PyPI.
168168
You can ``import ultraplot; print(ultraplot.__file__)`` to verify your
169169
local copy has been imported.
170170

@@ -203,8 +203,8 @@ Here is a quick guide for submitting pull requests:
203203
..
204204
#. Run all the tests. Now running tests is as simple as issuing this command:
205205
.. code-block:: bash
206-
coverage run --source ultraplot -m py.test
207-
This command will run tests via the ``pytest`` tool against Python 3.7.
206+
coverage run --source ultraplot -m pytest
207+
This command will run tests via the ``pytest`` tool.
208208
209209
#. If you intend to make changes or add examples to the user guide, you may want to
210210
open the ``docs/*.py`` files as
@@ -235,7 +235,7 @@ Here is a quick guide for submitting pull requests:
235235
compare: your-branch-name
236236
237237
base-fork: ultraplot/ultraplot
238-
base: master
238+
base: main
239239
240240
Note that you can create the pull request before you're finished with your
241241
feature addition or bug fix. The PR will update as you add more commits. UltraPlot
@@ -249,8 +249,8 @@ Ultraplot follows EffVer (`Effectual Versioning <https://jacobtomlinson.dev/effv
249249

250250
While version 1.0 has been released, we are still in the process of ensuring proplot is fully replaced by ultraplot as we continue development under the ultraplot name. During this transition, the versioning scheme reflects both our commitment to stable APIs and the ongoing work to complete this transition. The minor version number is incremented when changes require user attention (like deprecations or style changes), and the patch number is incremented for additions and fixes that users can safely adopt.
251251

252-
For now, `Casper van Eltern <https://github.com/cvanelteren>`__ is the only one who can
253-
publish releases on PyPi, but this will change in the future. Releases should
252+
For now, `Casper van Elteren <https://github.com/cvanelteren>`__ is the only one who can
253+
publish releases on PyPI, but this will change in the future. Releases should
254254
be carried out as follows:
255255

256256
#. Create a new branch ``release-vX.Y.Z`` with the version for the release.

0 commit comments

Comments
 (0)