Skip to content

Commit bca4f9c

Browse files
author
Alan Christie
committed
docs: Docs on devcontainer
1 parent 6ddca27 commit bca4f9c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,9 @@ The project's written in Python and uses `Poetry`_ for dependency and package
3838
management. We also use `pre-commit`_ to manage our pre-commit hooks, which
3939
rely on `black`_, `mypy`_, `pylint`_, amongst others.
4040

41-
Create your environment::
41+
From within a VS Code `devcontainer`_] environment (recommended)::
4242

43-
poetry shell
44-
poetry install --with dev
43+
poetry install --with dev --sync
4544
pre-commit install -t commit-msg -t pre-commit
4645

4746
And then start by running the pre-commit hooks to ensure you're stating with a
@@ -51,9 +50,10 @@ _clean_ project::
5150

5251
And then run the tests::
5352

54-
coverage run -m pytest
55-
coverage report
53+
poetry run coverage run -m pytest
54+
poetry run coverage report
5655

56+
.. _devcontainer: https://code.visualstudio.com/docs/devcontainers/containers
5757
.. _Poetry: https://python-poetry.org
5858
.. _pre-commit: https://pre-commit.com
5959
.. _black: https://github.com/psf/black

0 commit comments

Comments
 (0)