Repository navigation
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding a dev container configuration to make developing in the project more portable.
The container created by the config provides a stable, known-good environment to start development. It is purely additive, and folks who do not want to use it can simply ignore it.
What's included
The container:
uv syncwhen the container is created.venvdevcontainer-lock.jsonpins the versions of each feature for reproducibilityAdded a new section to README_DEVELOPERS.md.
Notes
uv.lockis not tracked or ignored in.gitignore; this means every user who uses the dev container will get theuv.lockfile and it will be untracked. This is true today for anyone who currently runsuv syncanyway. I will follow up with a future PR on adding theuv.lockto version control or ignoring it based on the maintainer's preferences.Testing
I tested on Windows 11 via WSL2 and Docker Desktop in VS Code. After rebasing onto main, import was successful, pytest ran successfully, docs can be built, and pre-commit runs as expected.
I did not test macOS or Apple Silicon, GitHub Codespaces, or other editors. The image includes arm64 builds, but I did not test that.
AI disclosure
I used AI to help build out the dev container and to help with phrasing the new sections in the README and in this PR. I fact-checked every point and understand the full intent of the dev container file.
Dev container docs