Update readme to note current repo state#63292
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s README contribution guidance to reflect the post–TypeScript 6.0 state, clarifying what kinds of changes are accepted here and directing most work elsewhere.
Changes:
- Adds a “NOTE” under Contribute describing the limited scope of accepted fixes in this repo.
- Directs most bug fixes to the
typescript-gorepository and notes feature work is paused until 7.0.
Comments suppressed due to low confidence (1)
README.md:37
- The README links to
https://github.com/microsoft/TypeScript-go, but CONTRIBUTING.md points contributors tohttps://github.com/microsoft/typescript-go. Please use a single canonical URL/casing across docs to avoid confusion and ensure consistent linking.
Most bug fixes should be submitted to the [typescript-go](https://github.com/microsoft/TypeScript-go) repository.
| * Crashes that were introduced in 5.9 or 6.0 that *also* repro in 7.0 *and* have a portable fix *and* don't incur other behavioral changes | ||
| * Security issues | ||
| * Language service crashes that substantially impact mainline usage | ||
| * Serious regressions from 5.9 (these must *seriously* impact a *large* proportion of users) |
There was a problem hiding this comment.
The new bullet list is indented (two leading spaces before *), but other lists in this README are not. Consider removing the extra indentation to keep Markdown formatting consistent within the file.
| * Crashes that were introduced in 5.9 or 6.0 that *also* repro in 7.0 *and* have a portable fix *and* don't incur other behavioral changes | |
| * Security issues | |
| * Language service crashes that substantially impact mainline usage | |
| * Serious regressions from 5.9 (these must *seriously* impact a *large* proportion of users) | |
| * Crashes that were introduced in 5.9 or 6.0 that *also* repro in 7.0 *and* have a portable fix *and* don't incur other behavioral changes | |
| * Security issues | |
| * Language service crashes that substantially impact mainline usage | |
| * Serious regressions from 5.9 (these must *seriously* impact a *large* proportion of users) |
| * Serious regressions from 5.9 (these must *seriously* impact a *large* proportion of users) | ||
|
|
||
| Most bug fixes should be submitted to the [typescript-go](https://github.com/microsoft/TypeScript-go) repository. | ||
| Feature additions and behavorial changes are currently on pause until TypeScript 7.0 is completed. |
There was a problem hiding this comment.
Typo: "behavorial" should be "behavioral".
| Feature additions and behavorial changes are currently on pause until TypeScript 7.0 is completed. | |
| Feature additions and behavioral changes are currently on pause until TypeScript 7.0 is completed. |
| **NOTE: Code changes in this repo are now limited to a small category of fixes**: | ||
|
|
||
| * Crashes that were introduced in 5.9 or 6.0 that *also* repro in 7.0 *and* have a portable fix *and* don't incur other behavioral changes | ||
| * Security issues | ||
| * Language service crashes that substantially impact mainline usage | ||
| * Serious regressions from 5.9 (these must *seriously* impact a *large* proportion of users) | ||
|
|
||
| Most bug fixes should be submitted to the [typescript-go](https://github.com/microsoft/TypeScript-go) repository. | ||
| Feature additions and behavorial changes are currently on pause until TypeScript 7.0 is completed. |
There was a problem hiding this comment.
This guidance is inconsistent with CONTRIBUTING.md, which currently says all code changes should go to the typescript-go repo and that this repo only accepts critical 6.0 fixes. Consider aligning the wording here with CONTRIBUTING.md (and/or linking to it) so contributors get a single clear instruction.
This issue also appears on line 37 of the same file.
| **NOTE: Code changes in this repo are now limited to a small category of fixes**: | |
| * Crashes that were introduced in 5.9 or 6.0 that *also* repro in 7.0 *and* have a portable fix *and* don't incur other behavioral changes | |
| * Security issues | |
| * Language service crashes that substantially impact mainline usage | |
| * Serious regressions from 5.9 (these must *seriously* impact a *large* proportion of users) | |
| Most bug fixes should be submitted to the [typescript-go](https://github.com/microsoft/TypeScript-go) repository. | |
| Feature additions and behavorial changes are currently on pause until TypeScript 7.0 is completed. | |
| **NOTE: All code changes should be made in the [typescript-go](https://github.com/microsoft/TypeScript-go) repository. This repo only accepts a small category of critical TypeScript 6.0 fixes**: | |
| * Crashes that were introduced in 5.9 or 6.0 that *also* repro in 7.0 *and* have a portable fix *and* don't incur other behavioral changes | |
| * Security issues | |
| * Language service crashes that substantially impact mainline usage | |
| * Serious regressions from 5.9 (these must *seriously* impact a *large* proportion of users) | |
| For all other changes (including most bug fixes, new features, and behavioral changes), please use the [typescript-go](https://github.com/microsoft/TypeScript-go) repository as described in our [CONTRIBUTING](https://github.com/microsoft/TypeScript/blob/main/CONTRIBUTING.md) guidelines. | |
| Feature additions and behavioral changes are not currently being accepted in this repository. |
Per 6.0 release