-
Notifications
You must be signed in to change notification settings - Fork 536
Branches, Versions, and Releases
FluidFramework maintains one active development branch, main
, and an inactive, long-term stable branch, lts
.
main
branch in used to support our active (development) major release and its subsequent minor versions. Developers may only merge non-breaking changes into the main
branch excluding select break windows. This is enforced by way of automation where open PRs are checked for breaking changes (see also Breaking vs Non-breaking Changes). Release branches are created from main
for each major and minor release.
lts
is currently used to sustain our 1.x version.
FluidFramework packages conform to semantic versioning (semver) for versions 1.0.0
and later. Major versions are expected to be breaking, minor versions are expected to contain non-breaking incremental changes, and patch versions are expected to contain only bug fixes, security fixes, and other implementation-only changes. Versions prior to 1.0.0
follow a modified semver using virtual patch versioning.
Every 2-3 weeks, a client release branch is created from which packages are published to npmjs.
Tentatively every (approximately) 12-18 months, Fluid Framework will release new major version with some breaking changes.
Current long-term supported FF release is 2.x. The dates for 3.0 release have not been announced yet.
While each of the client releases versioned [major.minor.patch] are production releases, not all accessible code is meant for production. See Maintaining API support levels and customer API support levels.
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