plotly / dash

Data Apps & Dashboards for Python. No JavaScript Required.

https://plotly.com/dash

MIT License

21.53k stars 2.07k forks source link

Update CONTRIBUTING.md to have easier to read build steps #2951

Closed marthacryan closed 3 months ago

marthacryan commented 3 months ago

Updates the CONTRIBUTING.md file to split out a large list of bash commands separated by comments into smaller code chunks separated by text. This is easier to read because the comments blend in with the bash commands.

marthacryan commented 3 months ago

Oh I'm also noticing that there is no setup-tests.py file but that's the actual command in the package.json. Not sure if other people agree but I found that very confusing and I was looking for a file called setup-tests.py. Why wouldn't we call it something like setup-python-tests?

marthacryan commented 3 months ago

Also: should we be including specific virtual environment instructions? I use conda right now so I haven't tested whether it actually works with venv, but I would expect people to use their preferred python env. We could link to the docs for venv and conda instead?

emilykl commented 3 months ago

Also: should we be including specific virtual environment instructions? I use conda right now so I haven't tested whether it actually works with venv, but I would expect people to use their preferred python env. We could link to the docs for venv and conda instead?

We could say something along the lines of "instructions provided here for venv but you can use your preferred Python virtual environment manager (e.g. conda)".

I'm also OK with leaving as-is for now since the venv instructions were already there and you're just reformatting.

AnnMarieW commented 3 months ago

Nice updates here! :confetti_ball:

Any chance of helping get https://github.com/plotly/dash/pull/2893 over the finish line since you're in the neighborhood?

marthacryan commented 3 months ago

2893 ended up covering basically all of the changes in this PR, so I'm gonna go ahead and close this!