-
Notifications
You must be signed in to change notification settings - Fork 15
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 #185
Conversation
add sub-sections to Tools and mention mypy
for more information, see https://pre-commit.ci
Please fix this any way it's required..
Add about choice of IDEs and linters.
I added [tool.poetry.dev-dependencies]
pytest = "^6.2.5"
requests = "^2.31.0"
flake8 = "^3.9.2"
pre-commit = "^2.17.0"
pymarkdown = "^0.1.4"
mypy = "^1.5.1"
types-requests = "^2.31.0.2"
# flake8-black may be unnecessary?
flake8-black = "^0.3.6" IIRC the reason to mention We do need to restructure the documentation regardless, though, so certain other aspects of this PR we should continue working on. I'm gonna rename this PR and mark it as a draft because of the broader scope, and I might contribute some changes of my own. |
It looks like I should add an explanation of how to set up the correct Python virtual environment as I'm having to do for #197. |
I'm getting out of my depth here. I'd be happy for you to finish these changes to the documentation. Although useful to a novice, is it necesary to include 'tools to Python' in the contributing.md? |
tweak about PyCharm Community Edition
Closing this to tidy up. AFAICT the documentation is now adequate. |
add sub-sections to Tools and mention mypy