-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(contributing): fix list numbering
The numbering in a list is off, as it is missing step 3. Updating list numbers accordingly.
- Loading branch information
1 parent
60d8b64
commit 2367608
Showing
1 changed file
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
@@ -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 | ||
|
@@ -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 | ||
|