-
-
Notifications
You must be signed in to change notification settings - Fork 26
Updated contributing notes #27
base: master
Are you sure you want to change the base?
Conversation
@jvkersch would you mind taking a look at this quick update of the contributing notes? Having you onboard is a good opportunity to solve pain points which you might have encountered when getting started with the package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks quite good! I had two further comments/comments, which may be because I'm not familiar with Plotly deployment conventions.
- I had to manually install webpack (
npm install --save webpack
) before thebuild:all
command would work. Is this expected? - The
package.json
file refers to the Python interpreter asvenv/bin/python
, which presumably assumes that there is a virtual environment calledvenv
inside the package root directory. Would it make sense to assume that we're running within the virtual environment and refer to the Python interpreter simply aspython
? This would help with e.g. running within a Conda or EDM environment.
React and JavaScript, [this | ||
tutorial](https://dash.plot.ly/react-for-python-developers) is a good | ||
primer. In order to build the Javascript component: excecute at the root | ||
of the package |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you also want to add a comment about installing the Python package? (e.g. pip install -e .
or equivalent)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. Since I'm terrified by Javascript but fluent with Python I assumed it would be the same for other contributors but it could be the other way around :-)
Co-Authored-By: Joris Vankerschaver <[email protected]>
Thank you for your comments. For webpack I have to investigate a bit; it is included in the dependencies in the package.json but maybe not at the right place... |
I was looking at the contributing notes for dash-bio and they describe running |
No description provided.