Skip to content

239 update developer setup documentation#240

Open
blakedehaas wants to merge 2 commits intomainfrom
239-update-developer-setup-documentation
Open

239 update developer setup documentation#240
blakedehaas wants to merge 2 commits intomainfrom
239-update-developer-setup-documentation

Conversation

@blakedehaas
Copy link
Copy Markdown
Collaborator

Checklist

(Need feedback on how/if to handle these two)

  • The changelog.md has been updated if necessary
  • Dependency spec updated if necessary

Summary

Updated Developer Documentation to remove docker-compose references and add missing commands

@blakedehaas blakedehaas requested a review from medley56 as a code owner March 9, 2026 17:41
@blakedehaas blakedehaas linked an issue Mar 9, 2026 that may be closed by this pull request
@blakedehaas blakedehaas added the documentation Improvements or additions to documentation label Mar 9, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.82%. Comparing base (9a65ffb) to head (3e462cf).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@@ -1,5 +1,9 @@
# Developer Documentation

## Environment Setup
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@medley56 medley56 force-pushed the 239-update-developer-setup-documentation branch from dff68a6 to 3e462cf Compare April 2, 2026 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Developer Setup Documentation

2 participants