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

Review RC [doc]: environment instructions for dev #63

Open
rcaneill opened this issue Apr 24, 2024 · 3 comments
Open

Review RC [doc]: environment instructions for dev #63

rcaneill opened this issue Apr 24, 2024 · 3 comments

Comments

@rcaneill
Copy link

Hi,
I am starting my in-depth review and will open issues with my questions / comments on the fly.

I believe that the package is missing some instructions for devs, like:

  • how to install the dev environment
  • how to run the tests

Here is what I did, I guess it is what should be done:

# install
pip install -e .
pip install -r requirements_dev.txt

# run the tests
pytest harmonize_wq
@rcaneill
Copy link
Author

cf #64 The instructions should probably be:

# install
pip install -e .
pip install -r requirements.txt
pip install -r requirements_dev.txt

# run the tests
pytest harmonize_wq

@rcaneill rcaneill changed the title Review RC: environment instructions for dev Review RC [doc]: environment instructions for dev Apr 24, 2024
@jbousquin
Copy link
Collaborator

Hi @rcaneill - This (pip install from requirements_dev) was added to the docs contributing page on the pyOpenSci-review branch. Once that is passing, merged and the docs built does it seem adequate to close this issue?

@rcaneill
Copy link
Author

It's good to see it somewhere. However, I believe that "explicit is better than implicit", and so providing the exact commands to type should be done, as in #63 (comment)

I can open a PR for that, or let you do it (or if you disagree please tell me why)

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

No branches or pull requests

2 participants