Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contributing): fix list numbering #467

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
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