-
Notifications
You must be signed in to change notification settings - Fork 245
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add breaking change policy to website #6049
Draft
timotheeguerin
wants to merge
5
commits into
main
Choose a base branch
from
breaking-change-policy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+57
−0
Draft
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
66b21fc
Add breaking change policy to website
timotheeguerin 4ed2829
Apply suggestions from code review
timotheeguerin a7143d6
Merge branch 'main' into breaking-change-policy
timotheeguerin 2b1cda7
Apply suggestions from code review
timotheeguerin 5776fd4
Update website/src/content/docs/docs/handbook/breaking-change-policy.mdx
timotheeguerin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Apply suggestions from code review
Co-authored-by: Brian Terlson <brian.terlson@microsoft.com>
- Loading branch information
commit 4ed282985d885c32dce7ee5510f8f15390b7c2e9
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -16,12 +16,14 @@ TypeSpec Compiler and libraries follow [semver](https://semver.org/) for version | |||||
|
||||||
## Breaking Change Philosophy | ||||||
|
||||||
The basic of the policy can be summarized as follows, we guarantee stability for runtime behavior but not for the build process. | ||||||
The basic of the policy can be summarized as follows: existing language syntax and semantics will not change without a major version. The runtime behavior for a given TypeSpec will not change without a major version. TypeSpecs leveraging new or updated features may cause runtime API consumers to fail (e.g. because a new type is unhandled) or builds to fail (e.g. because exhaustive unions are no longer exhaustive). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
`` | ||||||
|
||||||
- The language syntax and semantics for existing language elements will not change within a major version. | ||||||
- A spec that was building successfully should build successfully with the new version of the compiler and libraries with the same major version. | ||||||
timotheeguerin marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- New types and functionalities can be added in a minor version release. | ||||||
- If a spec updates to use that new functionality/type it is not considered a breaking change if it goes through a library/emitter that will now break. | ||||||
- TypeScript types might change in ways that introcue compilation type checking errors. Those are not considered breaking changes. | ||||||
- TypeScript types might change in ways that introduce compilation type checking errors. Those are not considered breaking changes. | ||||||
|
||||||
### Bugs | ||||||
|
||||||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add the stdout of the compiler is not a contract, use teh api for programmatic usage