adafruit-mirror/circup
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add devcontainer instructions

Browse source
This commit is contained in:
Jev 2024-05-05 21:50:53 +00:00
parent b6f049f8af
commit 20c7d6337e
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
CONTRIBUTING.rst
View file

@ -30,11 +30,35 @@ Developer Setup
`Black code formatter <https://black.readthedocs.io/en/stable/index.html>`_ `Black code formatter <https://black.readthedocs.io/en/stable/index.html>`_
(which only works with Python 3.6+). (which only works with Python 3.6+).
Clone the repository and from the root of the project, Clone the repository and from the root of the project,
Local Environment
^^^^^^^^^^^^^^^^^^
setup a virtual environment and activate it.::
python3 -m venv .env
source .env/bin/activate
install the requirements:: install the requirements::
pip install -e ".[dev]" pip install -e ".[dev]"
VSCode devcontainer
^^^^^^^^^^^^^^^^^^
This repository provides a `.devcontainer` environment that can be used in VSCode. For more information, read [VSCode containers docs](https://code.visualstudio.com/docs/devcontainers/containers)
Everything is installed and setup automatically when you launch VSCode in the devcontainer.
------------------------------------------------------------------------
Run the test suite:: Run the test suite::
pytest --random-order --cov-config .coveragerc --cov-report term-missing --cov=circup pytest --random-order --cov-config .coveragerc --cov-report term-missing --cov=circup