Update contribution guidelines around type annotations #1063
Conversation
This file contains 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
Since Qiskit#1061 has merged rustworkx is now fully typed with mypy. This means that adding type annotations is no longer optional and is now required for all new function. This commit updates the contribution guidelines to indicate type annotations are required now. The details are also updated a bit to provide a bit more detail on what's required when adding type annotations to rustworkx.
Pull Request Test Coverage Report for Build 7602284307
💛 - Coveralls |
IvanIsCoding
approved these changes
Jan 21, 2024
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.
Since #1061 has merged rustworkx is now fully typed with mypy. This means that adding type annotations is no longer optional and is now required for all new function. This commit updates the contribution guidelines to indicate type annotations are required now. The details are also updated a bit to provide a bit more detail on what's required when adding type annotations to rustworkx.