Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #240 +/- ##
=======================================
Coverage 94.82% 94.82%
=======================================
Files 48 48
Lines 3868 3868
=======================================
Hits 3668 3668
Misses 200 200 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -1,5 +1,9 @@ | |||
| # Developer Documentation | |||
|
|
|||
| ## Environment Setup | |||
There was a problem hiding this comment.
I think we need to make a distinction in these docs that these steps are only required if a user is not using the devcontainer. If they are in the devcontainer, all of this setup should already be taken care of.
|
|
||
| to get pre-commit hooks to automatically run the linting and formatting checks for you before each commit. | ||
|
|
||
| Authentication with Github is required to push to the repository. We suggest using SSH key authentication. |
There was a problem hiding this comment.
I'm pretty sure Github won't let you use HTTPS any more so this is a basic standard requirement, not a recommendation by us.
| curl -LsSf https://astral.sh/uv/install.sh | sh | ||
|
|
||
| # Load env vars and PATH settings | ||
| source $HOME/.local/bin/env |
There was a problem hiding this comment.
This is very environment dependent. In the devcontainer, this should be taken care of. Outside the devcontainer, it's the wild west and I don't think we can provide a suggestion to users. They just need to know their development environment. For example, I don't even have an env file in this location.
| uv sync --all-extras | ||
|
|
||
| # Activate the virtual environment | ||
| source .venv/bin/activate |
There was a problem hiding this comment.
This is up to user IDE configuration and how they want to use the virtual environment. Most IDEs will default to automatically activating the venv for new terminal sessions but users can manage that however they want to.
dff68a6 to
3e462cf
Compare
Checklist
(Need feedback on how/if to handle these two)
Summary
Updated Developer Documentation to remove docker-compose references and add missing commands