hthiery/python-fritzhome

View on GitHub
doc/CONTRIBUTING.rst

Summary

Maintainability
Test Coverage
================================
Contributing to python-fritzhome
================================

----------------------------------------
Use the Visual Studio Code dev-container
----------------------------------------

The easiest way to get started with development is to use Visual Studio Code with devcontainers_. This approach will create a preconfigured development environment with all the tools you need.

.. _devcontainers: https://code.visualstudio.com/docs/remote/containers

**Prerequisites**

- `Docker`_
- `Visual Studio code`_

.. _Docker: https://docs.docker.com/install/
.. _Visual Studio code: https://code.visualstudio.com/


**Tasks**

The devcontainer comes with some useful tasks to help you with development, you can start these tasks by opening the command palette and select Tasks: Run Task then select the task you want to run.

- Run setup: This will install the library from source
- Run tests: This will run the all tests