README updates #226
README updates #226
Conversation
Installing trino-python-client with the sqlalchemy extra like `pip install trino[sqlalchemy]` automatically installs required version of SQLAlchemy.
|
I left out pre-commit setup for now since CI enforces things for now but we can decide what parts to offload to PR authors (e.g. import sorting, automated reformat). I'm wary of requiring something like |
There was a problem hiding this comment.
Thanks!. Re I left out pre-commit setup for now are you referring to #208 (comment) ?
| @@ -448,6 +438,9 @@ When the code is ready, submit a Pull Request. | |||
| - Prefer code that is readable over one that is "clever". | |||
| - When writing a Git commit message, follow these [guidelines](https://chris.beams.io/posts/git-commit/). | |||
|
|
|||
| See also Trino's [guidelines](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md). | |||
There was a problem hiding this comment.
What about creating DEVELOPMENT.md or CONTRIBUTING.md exclusively for trino-python-client? It can be done as a follow-up and move there all necessary information about testing, contributing?
There was a problem hiding this comment.
README is still the place where build instructions should live.
Things like code style, release process etc. can go to DEVELOPMENT.md.
I'll send a follow-up PR - thanks for the idea.
Also switch all headers to sentence case to match Trino documentation.
hashhar
force-pushed
the
hashhar/readme-cleanup
branch
from
75888bc to
61c867e
Compare
Yes, I mean someone should add pre-commit setup instruction to README. Or alternatively we can only add things we really want to check before commit to pre-commit (like sort imports, auto reformat) but keep other things like mypy and tests outside of it. |
|
I'll follow up with dedicated DEVELOPMENT.md/CONTRIBUTING.md. |
Most of this is "refactor".
Actual useful/impacting content changes are:
PTAL @ebyhr at Update releasing instructions in README specially. I'm not sure if the trailing slash was intentionally left out (to prevent copy and paste?).