Documentation: Add CONTRIBUTING.md and DEVELOPMENT.md #158
Conversation
This file contains hidden or 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
Closed
eyurtsev
approved these changes
Feb 4, 2025
DEVELOPMENT.md
Outdated
| Install package, editable. | ||
| ```shell | ||
| poetry install --with dev,test,lint | ||
| pip install greenlet |
There was a problem hiding this comment.
curious why is greenlet required?
There was a problem hiding this comment.
and if required should it just be in pyproject.toml?
There was a problem hiding this comment.
Hi @eyurtsev, thanks for your reply.
a) I will dig out again why greenlet is required, to check if I have not been misguided.
b) True. I will add it using another PR if it's really needed.
There was a problem hiding this comment.
Hi again. I've removed pip install greenlet here, and staged another PR instead, after confirming on my workstation that running software tests indeed fail all "async" test cases if greenlet is not installed.
I wonder why it works well on CI/GHA?
amotl
force-pushed
the
contributing-docs
branch
from
e879e8d to
0b1e8a1
Compare
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 suggested by @Sachin-Bhat per GH-92.