Skip to content
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

Closed
wants to merge 5 commits into from
Closed

Conversation

azzamh15
Copy link
Contributor

@azzamh15 azzamh15 commented Mar 15, 2024

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.

pip install -e .\[dev,docs\]
@azzamh15 azzamh15 requested a review from gnikit as a code owner March 15, 2024 13:21
Copy link

codecov bot commented Mar 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.52%. Comparing base (3386073) to head (3a6c190).

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.
📢 Have feedback on the report? Share it here.

Copy link
Member

@gnikit gnikit left a 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]"

@azzamh15
Copy link
Contributor Author

I get it you are right i am closing this

@azzamh15 azzamh15 closed this Mar 15, 2024
@gnikit
Copy link
Member

gnikit commented Mar 15, 2024

No need to close, you can change the \ to " and I would be happy to merge.

@azzamh15 azzamh15 reopened this Mar 15, 2024
@azzamh15
Copy link
Contributor Author

Done

@azzamh15

This comment was marked as resolved.

@azzamh15
Copy link
Contributor Author

This is a bit messed up so opening another in lieu of this
see #361

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants