-
-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update CONTRIBUTING.md #360
Conversation
pip install -e .\[dev,docs\]
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #360 +/- ##
=======================================
Coverage 87.52% 87.52%
=======================================
Files 35 35
Lines 4760 4760
=======================================
Hits 4166 4166
Misses 594 594 ☔ View full report in Codecov by Sentry. |
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.
We use sh & bash for development, not zsh so the docs are consistent with the selection.
Users of other shells should adapt the instructions. Burden of such documentation is rarely taken up by the project (see sktime
for example). The implicit assumption is that developers can figure out how to install a generic Python package on their machine.
The most readable solution to a generic prompt would be to use double quotes, like in pandas
pip install -e ".[dev,docs]"
I get it you are right i am closing this |
No need to close, you can change the |
Done |
This comment was marked as resolved.
This comment was marked as resolved.
This is a bit messed up so opening another in lieu of this |
The command wasn't working on zsh (which is default shell on macOS) as square brackets are used for pattern matching on zsh , using ' \ ' before square brackets works on both zsh and bash.