search

open-telemetry / opentelemetry-python

OpenTelemetry Python API and SDK
https://opentelemetry.io
Apache License 2.0
1.81k stars 633 forks source link

Missing step to setup virtual env in CONTRIBUTING.md #4212

Open Annosha opened 1 month ago

Annosha commented 1 month ago

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

emdneto commented 1 month ago

Improvements are always welcome; please feel free to open a PR with your changes.