open-telemetry / open-telemetry/opentelemetry-python
Missing step to setup virtual env in CONTRIBUTING.md
@Annosha is already working on this.
Since Oct 17, 2024.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
Is your feature request related to a problem?
As a new comer I was setting up development environment on my local machine following the instructions CONTRIBUTING.md.
The instructions were difficult to follow due to the sequence of the steps. Some steps are missing while some need more explanation.
Respective commands to run on a Windows environment are missing as well.
Attached file where I've tried to rewrite the steps to setup dev environment while checking the sequence of commands on my local machine too.
Please leave your feedback and suggestions for further improvements.
@pmcollins @emdneto @jeremydvoss @owais @shalevr @srikanthccv @lzchen
doc: CONTRIBUTION.md
Describe the solution you'd like
I'd like to rewrite CONTRIBUTION.md in sequential order to make it clear so new comers don't have difficulty going through the steps.
Describe alternatives you've considered
Please go through this google doc and provide valuable feedback. Together we can make the documentations clear and easy to understand.
Additional Context
No response
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.
Assessment
This issue has not been assessed yet.