docs: CONTRIBUTING.md #547
Conversation
CONTRIBUTING.md
Outdated
| Install the development environment (once) with | ||
|
|
||
| ```bash | ||
| uv venv |
There was a problem hiding this comment.
python -m venv
rather than assume users have uv (or conda or whatever)
CONTRIBUTING.md
Outdated
| Source development environment with | ||
|
|
||
| ```bash | ||
| source .venv/bin/activate |
There was a problem hiding this comment.
Doesn't this need to come before pip install?
There was a problem hiding this comment.
In general yes, but not with uv. If it finds a venv (even though it is not activated) it will install software into it.
There was a problem hiding this comment.
OK, so if we remove requiring uv, then this will need to be reordered. That's conceptually cleaner anyway, if you ask me.
CONTRIBUTING.md
Outdated
| Run tests with | ||
|
|
||
| ```bash | ||
| pytest . |
There was a problem hiding this comment.
| pytest . | |
| pytest -v |
CONTRIBUTING.md
Outdated
| Build documentation with | ||
|
|
||
| ```bash | ||
| cd docs && make html |
There was a problem hiding this comment.
Does && work on windows?
Also worth saying where the docs end up.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #547 +/- ##
==========================================
- Coverage 93.06% 93.00% -0.07%
==========================================
Files 23 22 -1
Lines 3290 3387 +97
==========================================
+ Hits 3062 3150 +88
- Misses 228 237 +9 ☔ View full report in Codecov by Sentry. |
|
Thank you very much for pointing to the contribution guide in the documentation - I didn't see it! |
No description provided.