added GitHub Codespaces setup instructions to CONTRIBUTING.md#306
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #306 +/- ##
=======================================
Coverage 79.19% 79.19%
=======================================
Files 51 51
Lines 5561 5561
Branches 583 583
=======================================
Hits 4404 4404
Misses 1157 1157
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
sarahmonod
left a comment
There was a problem hiding this comment.
This looks great! Thanks for contributing to our open source project. I think a few small things can be improved though, can you please take a look and tell me what you think of them?
sarahmonod
left a comment
There was a problem hiding this comment.
LGTM, thanks @suiiibhit!
|
Ah woops, it looks like the dco wasn't added. Can you please run |
7fb6101 to
6bdc4dc
Compare
Additionally, configure `prek` hooks in Codespaces. Signed-off-by: suiiibhit <shubhitsaxena2005@gmail.com> Co-authored-by: Matt Wozniski <godlygeek@gmail.com>
6bdc4dc to
c7c3619
Compare
godlygeek
left a comment
There was a problem hiding this comment.
Looks good to me as well, though I reverted the changes to reference requirements-test.txt and requirements-extra.txt in devcontainer.json - the test and extra dependencies are already installed by the Dockerfile that the devcontainer builds on top of, so adding those to the install was redundant, and it conflicts with #296, which removed those files in favor of using dependency groups.
Closes: #291
Issue number of the reported bug or feature request: #291
Describe your changes
Added a "Setting up a development environment" section to CONTRIBUTING.md
documenting how to use GitHub Codespaces as well as local setup steps.
Also expanded the dev container's
onCreateCommandto install all contributordependencies (
requirements-test.txt,requirements-extra.txt) and configurepre-commit hooks automatically on container creation.
Testing performed
Verified the dev container configuration is valid JSON and that the
onCreateCommandinstalls all required dependencies for running tests andlinting. Confirmed no source files were modified.
Additional context
The
.devcontainer/devcontainer.jsonalready existed with the correct ptracecapabilities (
--cap-add=SYS_PTRACE,seccomp=unconfined) needed for pystackto work inside a container. This change ensures Codespaces is fully usable
out of the box and that contributors know it exists.