Skip to content

added GitHub Codespaces setup instructions to CONTRIBUTING.md#306

Merged
godlygeek merged 1 commit into
bloomberg:mainfrom
suiiibhit:chore/update-contributing.md
May 21, 2026
Merged

added GitHub Codespaces setup instructions to CONTRIBUTING.md#306
godlygeek merged 1 commit into
bloomberg:mainfrom
suiiibhit:chore/update-contributing.md

Conversation

@suiiibhit
Copy link
Copy Markdown
Contributor

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 onCreateCommand to install all contributor
dependencies (requirements-test.txt, requirements-extra.txt) and configure
pre-commit hooks automatically on container creation.

Testing performed
Verified the dev container configuration is valid JSON and that the
onCreateCommand installs all required dependencies for running tests and
linting. Confirmed no source files were modified.

Additional context
The .devcontainer/devcontainer.json already existed with the correct ptrace
capabilities (--cap-add=SYS_PTRACE, seccomp=unconfined) needed for pystack
to work inside a container. This change ensures Codespaces is fully usable
out of the box and that contributors know it exists.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.19%. Comparing base (178a765) to head (c7c3619).

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           
Flag Coverage Δ
cpp 79.19% <ø> (ø)
python 79.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

Copy link
Copy Markdown
Contributor

@sarahmonod sarahmonod left a comment

Choose a reason for hiding this comment

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

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?

Comment thread .devcontainer/devcontainer.json Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

@sarahmonod sarahmonod left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @suiiibhit!

@sarahmonod
Copy link
Copy Markdown
Contributor

Ah woops, it looks like the dco wasn't added. Can you please run git commit --amend -s @suiiibhit ?

@suiiibhit suiiibhit force-pushed the chore/update-contributing.md branch from 7fb6101 to 6bdc4dc Compare May 20, 2026 02:08
Additionally, configure `prek` hooks in Codespaces.

Signed-off-by: suiiibhit <shubhitsaxena2005@gmail.com>
Co-authored-by: Matt Wozniski <godlygeek@gmail.com>
@godlygeek godlygeek force-pushed the chore/update-contributing.md branch from 6bdc4dc to c7c3619 Compare May 21, 2026 05:22
Copy link
Copy Markdown
Contributor

@godlygeek godlygeek left a comment

Choose a reason for hiding this comment

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

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.

@godlygeek godlygeek enabled auto-merge (rebase) May 21, 2026 05:34
@godlygeek godlygeek merged commit 8e24ba7 into bloomberg:main May 21, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md to suggest using GitHub Codespaces

4 participants