-
Notifications
You must be signed in to change notification settings - Fork 549
npm package scopes
Packages that are part of the platform itself, including platform DDSes, protocol definitions, shared interfaces, as well as reference implementations of components of the system (e.g. Routerlicious). This is the "default" scope for packages in the FluidFramework repo.
Public packages containing tools developed within the Fluid Framework repo that may be of general use to Fluid and/or JavaScript developers.
Private packages (i.e. should NOT be published) used internally within the Fluid Framework repo. These packages contain infrastructure that can only be used by the Fluid Framework team. This enables a lower commitment to stable APIs, as breaking changes can only affect the FluidFramework repository. These packages are generally not published internally but may facilitate validation pipelines.
Packages that are experimental and should not be used in critical scenarios. We use this scope when we're not sure if a package should be included in the platform SDK. Some platform packages will start in this scope and be renamed and published under the @fluidframework scope once the package is no longer considered experimental.
This is a package that re-exports the official "public API" for GA. Everything exposed through this package is also exposed in a @fluidframework package.
This is the server version of the tinylicious package. Installed/run via npx tinylicious
.
@fluidframework, fluid-framework and tinylicious follow the deprecation policy. Packages that do not conform to the policy can be removed without following the deprecation policy
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