-
Notifications
You must be signed in to change notification settings - Fork 200
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
Document how to run tests locally #256
Comments
Specifically:
Obviously, I would not be writing this unless I would have certainty that the above commands are valid. ;) |
True, true. I'll add that to README! It's |
This being the case, it would also be helpful to have instructions on how to install |
I've added a section to the README that should explain this essential process: https://github.com/ipfs-shipyard/py-ipfs-http-client#setting-up-a-local-development-environment Feedback? Anything that should be expended upon? |
Feedback in #270. https://pypi.org/project/pytest-docker/ is a potential future improvement on this. |
Just a link to the go-ipfs documentation on this should suffice, and of course mentioning that it is a requirement for testing. |
@dokterbob do you have any follow up questions on this? |
As a contributor, I was unable to successfully run the tests locally. It would be great to have a few lines in the README on how to do this, without having to plough through or know much about the actual tooling to use.
Note that in the case of the more likely contributions, it would make most sense to be able to run a single pass of the tests on whatever locally installed Python, as to have a quicker evaluation - and to have the CI take care of more extensive platform-testing.
The text was updated successfully, but these errors were encountered: