From 20c7d6337ebb8a4f3bb44afa9244f63fffa5aaf2 Mon Sep 17 00:00:00 2001 From: Jev Date: Sun, 5 May 2024 21:50:53 +0000 Subject: [PATCH] add devcontainer instructions --- CONTRIBUTING.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b3a851a..89703be 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -30,11 +30,35 @@ Developer Setup `Black code formatter `_ (which only works with Python 3.6+). + + 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:: 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:: pytest --random-order --cov-config .coveragerc --cov-report term-missing --cov=circup