Skip to content

Commit 4101835

Browse files
committed
DOC: Adjust indentation in doc
skipci
1 parent 21c6598 commit 4101835

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

docs/source/updating_services.rst

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,57 +14,55 @@ Instructions
1414

1515
1. Check out and pull the ``main`` branch
1616

17-
.. code-block:: shell
18-
git checkout main
19-
git pull
17+
.. code-block:: shell
18+
git checkout main
19+
git pull
2020
2121
2. If not already installed, install your service locally.
2222

23-
If using ``poetry``:
23+
If using ``poetry``:
2424

25-
.. code-block:: shell
26-
poetry install
25+
.. code-block:: shell
26+
poetry install
2727
28-
If using ``pip``:
28+
If using ``pip``:
2929

30-
.. code-block:: shell
31-
pip install -e .
30+
.. code-block:: shell
31+
pip install -e .
3232
3333
3. If using ``pre-commit``, make sure it's set up properly (you only need to do this once per repository, not on every update)
3434

35-
.. code-block:: shell
36-
pre-commit install && pre-commit install -t commit-msg
35+
.. code-block:: shell
36+
pre-commit install && pre-commit install -t commit-msg
3737
3838
4. Check out a new branch
3939

40-
.. code-block:: shell
41-
git checkout -b my-new-feature
40+
.. code-block:: shell
41+
git checkout -b my-new-feature
4242
4343
5. Add and make changes to your app's code as needed, committing each self-contained change to git
4444

45-
.. code-block:: shell
46-
git add changed-file.py another-changed-file.py
47-
git commit
48-
... repeat ...
45+
.. code-block:: shell
46+
git add changed-file.py another-changed-file.py
47+
git commit
48+
... repeat ...
4949
50-
Push your commits frequently so your work is backed up on your git provider (e.g. GitHub)
50+
Push your commits frequently so your work is backed up on your git provider (e.g. GitHub)
5151

52-
.. code-block:: shell
53-
git push
52+
.. code-block:: shell
53+
git push
5454
5555
6. Write any new tests you need to verify your code works and update any old tests as needed
5656

5757
7. Run the tests locally using e.g. ``pytest`` or ``python -m unittest``
5858

5959
8. Update the semantic version of your app. If you're using ``poetry``, run:
6060

61-
- ``poetry version patch`` for a bug fix or small non-code change
62-
- ``poetry version minor`` for a new feature
63-
- ``poetry version major`` for a breaking change
61+
- ``poetry version patch`` for a bug fix or small non-code change
62+
- ``poetry version minor`` for a new feature
63+
- ``poetry version major`` for a breaking change
6464

65-
If you're using ``pip`` , manually update the version in ``setup.py`` or ``pyproject.toml``
66-
67-
Don't forget to commit this change, too.
65+
If you're using ``pip``, manually update the version in ``setup.py`` or ``pyproject.toml``. Don't forget to commit this change, too.
6866

6967
9. When you're ready to review the changes, head to GitHub and open a pull request of your branch into ``main``. Check the diff to make sure everything's there and consistent (it's easy to forget to push everything). Ask your colleagues to review the code if required.
7068

0 commit comments

Comments
 (0)