Add developer tools used in CI checks to requirements and add documentation on their use in this project #161
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I omitted |
joerick
reviewed
Nov 7, 2021
There was a problem hiding this comment.
Thanks @goxberry ! I was looking for this information earlier in fact!
I think it's perhaps easier to use these tools through the pre-commit tool, which handles the installation and configuration. So I've suggested changing it to that.
goxberry
force-pushed
the
add-dev-tools-to-requirements-and-docs
branch
from
9740d31 to
235795a
Compare
This commit adds a numpy dependency to the requirements-dev.txt file because numpy is used by one of the examples, and running examples is useful for testing.
This commit adds the pre-commit package, which is used by the project in its CI testing. The purpose of adding this package is to enable developers to run the same tests locally to find and fix errors that would otherwise be flagged by CI.
This commit adds directions for running CI checks locally to the project README.md.
This commit adds some additional instructions on using developer tools to conform to project style checks in CI.
goxberry
force-pushed
the
add-dev-tools-to-requirements-and-docs
branch
from
235795a to
69adad3
Compare
|
Rebased on more recent version of |
joerick
approved these changes
Nov 14, 2021
|
Thanks @goxberry ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of work on #160, I realized I wasn't running certain checks the CI was doing, and these checks caused CI testing failures. This pull request attempts to head off that situation in the future by:
pre-commit,isort,black, and a Pythonpyrightwrapper to diagnose and fix style errors and static analysis bugs