Skip to content

Commit

Permalink
docs(contributing): fix list numbering
Browse files Browse the repository at this point in the history
The numbering in a list is off, as it is missing step 3. Updating list numbers accordingly.
  • Loading branch information
bug-sentinel committed Nov 1, 2024
1 parent 60d8b64 commit 2367608
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Create pull request
# upstream [email protected]:equinor/pyscal (fetch)
# upstream [email protected]:equinor/pyscal (push)
4. Install your forked copy into a local venv:
3. Install your forked copy into a local venv:

.. code-block:: bash
Expand All @@ -34,21 +34,21 @@ Create pull request
pip install -U pip
pip install -e ".[tests,docs]"
5. Run the tests to ensure everything works:
4. Run the tests to ensure everything works:

.. code-block:: bash
pytest -n auto
6. Create a branch for local development:
5. Create a branch for local development:

.. code-block:: bash
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.

7. When you're done making changes, check that your changes pass ruff, mypy and the
6. When you're done making changes, check that your changes pass ruff, mypy and the
tests:

.. code-block:: bash
Expand All @@ -71,15 +71,15 @@ Only use deviations when e.g. ruff and pylint are in conflict, or if conformity
pylint would clearly make the code worse or not work at all. Do not use it to
increase pylint score.

8. Commit your changes and push your branch to GitHub:
7. Commit your changes and push your branch to GitHub:

.. code-block:: bash
git add file1.py file2.py
git commit -m "Add some feature"
git push origin name-of-your-bugfix-or-feature
9. Submit a pull request through GitHub.
8. Submit a pull request through GitHub.


Building documentation
Expand Down

0 comments on commit 2367608

Please sign in to comment.