[ty] contribution guide #18061
Merged
[ty] contribution guide #18061
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
carljm
requested review from
AlexWaygood,
MichaReiser,
dcreager and
sharkdp
as code owners
dcreager
reviewed
May 13, 2025
carljm
force-pushed
the
cjm/contributing-guide
branch
2 times, most recently
from
833d685 to
984f0fa
Compare
carljm
force-pushed
the
cjm/contributing-guide
branch
from
984f0fa to
c670424
Compare
Contributor
|
dhruvmanila
reviewed
May 13, 2025
Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
MichaReiser
approved these changes
May 13, 2025
Member
MichaReiser
left a comment
MichaReiser
left a comment
There was a problem hiding this comment.
This looks good. We should add a link from the ty CONTRIBUTING.md to this document.
MichaReiser
added
documentation
dcreager
added a commit
that referenced
this pull request
May 13, 2025
…eep-dish * origin/main: [ty] __file__ is always a string inside a Python module (#18071) [ty] Recognize submodules in self-referential imports (#18005) [ty] Add a note to the diagnostic if a new builtin is used on an old Python version (#18068) [ty] Add tests for `else` branches of `hasattr()` narrowing (#18067) [ty] Improve diagnostics for `assert_type` and `assert_never` (#18050) [ty] contribution guide (#18061) [ty] Implement `DataClassInstance` protocol for dataclasses. (#18018) [ruff_python_ast] Fix redundant visitation of test expressions in elif clause statements (#18064)
Glyphack
pushed a commit
to Glyphack/ruff
that referenced
this pull request
May 21, 2025
First take on a contributing guide for `ty`. Lots of it is copied from the existing Ruff contribution guide. I've put this in Ruff repo, since I think a contributing guide belongs where the code is. I also updated the Ruff contributing guide to link to the `ty` one. Once this is merged, we can also add a link from the `CONTRIBUTING.md` in ty repo (which focuses on making contributions to things that are actually in the ty repo), to this guide. I also updated the pull request template to mention that it might be a ty PR, and mention the `[ty]` PR title prefix. Feel free to update/modify/merge this PR before I'm awake tomorrow. --------- Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com> Co-authored-by: David Peter <mail@david-peter.de>
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.
First take on a contributing guide for
ty. Lots of it is copied from the existing Ruff contribution guide.I've put this in Ruff repo, since I think a contributing guide belongs where the code is. I also updated the Ruff contributing guide to link to the
tyone.Once this is merged, we can also add a link from the
CONTRIBUTING.mdin ty repo (which focuses on making contributions to things that are actually in the ty repo), to this guide.I also updated the pull request template to mention that it might be a ty PR, and mention the
[ty]PR title prefix.Feel free to update/modify/merge this PR before I'm awake tomorrow.