mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-04-17 07:55:15 +00:00

Chris de9fe2ddc9 Add settings and extension recommendations (#139 )

- Added recommended settings for the Pylance and Pyright extensions
- Enabled pytest and debugging support in configuration
- Reformatted code with Prettier
---------
Co-authored-by: Chris <git@nootch.de>

2024-11-10 23:00:16 +01:00

1.3 KiB

Raw Blame History

Contributing to EOS

Thanks for taking the time to read this!

The EOS project is in early development, therefore we encourage contribution in the following ways:

Bug Reports

Please report flaws or vulnerabilities in the GitHub Issue Tracker using the corresponding issue template.

Ideas & Features

Please first discuss the idea in a GitHub Discussion or the Akkudoktor Forum before opening an issue.

There are just too many possibilities and the project would drown in tickets otherwise.

Code Contributions

We welcome code contributions and bug fixes via Pull Requests. To make collaboration easier, we require pull requests to pass code style and unit tests.

Code Style

Our code style checks use pre-commit.

pip install -r requirements-dev.txt

To run formatting automatically before every commit:

pre-commit install

Or run them manually:

pre-commit run --all-files

Tests

Use pytest to run tests locally:

python -m pytest -vs --cov src --cov-report term-missing tests/

1.3 KiB Raw Blame History