-
Notifications
You must be signed in to change notification settings - Fork 532
Dev Tools Maintenance
Periodically we'll want to update the version of TSC used to build our code. One consideration first is: Are there changes that would require downstream consumers of our libraries to also upgrade their version of TS? This has bitten us (and our partners) in the past (see this BREAKING.md entry), so double-check for breaking changes like that in the release notes. Assuming you go forward, the basic steps are:
- Edit the version in the package.json files across the repo.
- Run a clean npm i across all the packages including the server ( build:fast -- --symlink:full --install is helpful)
- Commit lock file and package.json changes.
- Ensure tests pass, etc.
- PR it.
The challenge will be in step 4. It's tough to say how many code or config changes might be needed across the repo. It might be trivial, but it really depends. Regardless, try to get your PR merged quickly though because lockfile changes are difficult to keep current.
This is also assuming you do not need to update the shared tsconfig in build-common in order to build with the new TSC. If you do, then the dance will be more complex.
This wiki is focused on contributing to the Fluid Framework codebase.
For information on using Fluid Framework or building applications on it, please refer to fluidframework.com.
- Submitting Bugs and Feature Requests
-
Contributing to the Repo
- Repo Basics
- Common Workflows and Patterns
- Managing dependencies
- Client Code
- Server Code
- PR Guidelines
- CI Pipelines
- Breaking vs Non-Breaking Changes
- Branches, Versions, and Releases
- Compatibility & Versioning
- Testing
- Debugging
- npm package scopes
- Maintaining API support levels
- Developer Tooling Maintenance
- API Deprecation
- Working with the Website (fluidframework.com)
- Coding Guidelines
- Documentation Guidelines
- CLA