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

Contributing guidelines do not explain how to use the required tools #29

Closed
pmeier opened this issue Oct 3, 2021 · 1 comment
Closed

Comments

@pmeier
Copy link

pmeier commented Oct 3, 2021

The guidelines mention black and pydocstyle, but no instructions how to use them. Additionally

utilities for building documentation, enabling the testing suite and publishing to PyPi

is fairly vague and one has to dig through the CI workflows for example to find how the tests should be run.

@a-ws-m
Copy link
Owner

a-ws-m commented Oct 14, 2021

I've added some more detailed information, please let me know if it's sufficient.

@pmeier pmeier closed this as completed Oct 15, 2021
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