summaryrefslogtreecommitdiff
path: root/CONTRIB.md
diff options
context:
space:
mode:
authorRoberto Bertó <463349+robertoberto@users.noreply.github.com>2025-09-19 09:15:47 -0300
committerGitHub <noreply@github.com>2025-09-19 09:15:47 -0300
commit1ada32975f0bb559ec7526e0dd545700dde1cb94 (patch)
treebdb8afb44adf8348c352591e4cd2783e9d54f409 /CONTRIB.md
parent9a69a954a086df321640dfa65a2ac0ac35a15095 (diff)
parentc8d043a5c87e0959327a5231ab1c5bfb5e9f2c47 (diff)
downloadpyvyos-1ada32975f0bb559ec7526e0dd545700dde1cb94.tar.gz
pyvyos-1ada32975f0bb559ec7526e0dd545700dde1cb94.zip
Merge pull request #22 from eduardormorais/release/0.3.0v0.3.0
Release/0.3.0
Diffstat (limited to 'CONTRIB.md')
-rw-r--r--CONTRIB.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIB.md b/CONTRIB.md
index 296cb44..3ff741d 100644
--- a/CONTRIB.md
+++ b/CONTRIB.md
@@ -20,7 +20,7 @@ There are many ways to contribute to pyvyos:
- Start by forking the repository and then cloning it to your local machine.
2. **Set Up Your Environment**
- - We recommend using Poetry for dependency management. Ensure you have Poetry installed and then run `poetry install` to set up your environment.
+ - We recommend using [uv](https://docs.astral.sh/uv/) for dependency management. Ensure you have Uv installed and then run `uv pip install -e .[dev]` to set up your environment.
3. **Create a Feature Branch**
- Create a branch for your feature or bugfix, e.g., `git checkout -b feature/add-new-command`.
@@ -68,12 +68,12 @@ Thank you for considering contributing to pyvyos. Your efforts are what make thi
## Unit Tests
Ensure you've installed development dependencies first:
```bash
- poetry install --with dev
+ uv pip install -e .[dev]
```
To view test coverage:
```bash
- pytest --cov
+ pytest -v --cov
```
**Note:** Tests should run against a development environment or mocked device to prevent production changes.