open-telemetry / open-telemetry/opentelemetry-python-contrib
Make it easier to contribute by including devcontainer.json
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
What problem do you want to solve?
Reduce friction for contributors - many of the suggested setup steps in contributing.md can be automated for users that want to use codespaces/devcontainers.
Describe the solution you'd like
Add devcontainer.json to the repo so that a user can create a codespace and immediately run common tox commands.
Describe alternatives you've considered
This can be handled by individual developers. I already have this setup for my codespaces but that only benefits me.
I think sharing this will reduce the barrier to entry / friction in the onboarding process for contributing.
Additional Context
I couldn't find any existing discussions about it - I think the burden of maintaining this is worth the benefit.
Would you like to implement a fix?
Yes
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with contributing.md and review the existing setup steps and common tox commands that the devcontainer should support. Add devcontainer.json so a new Codespace can follow the documented workflow and run those commands immediately; done means the documented contributor setup works in a fresh devcontainer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100