Describe an RFC process to request feedback for public API changes #2863
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
|
@swift-ci Please test |
plemarquand
reviewed
Jan 2, 2025
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
kimdv
approved these changes
Jan 3, 2025
|
@swift-ci Please test Windows |
1 similar comment
|
@swift-ci Please test Windows |
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.
swift-syntax is a widely used library, and any changes to its public API have a significant impact on its users. So far, we have evaluated this impact during PR reviews. While this has worked for us so far, it has the risk that a thorough review of public API changes gets lost in implementation comments. Furthermore, separating the PRs that have a public API impact from those that only change the implementation is hard, which effectively causes only swift-syntax contributors to share their opinions on the API design.
To improve this situation, I’m proposing that every change to swift-syntax’s public API should have an accompanying RFC post in the Swift forums, which explains the change and encourages feedback not only from swift-syntax contributors but also from swift-syntax users.