-
Couldn't load subscription status.
- Fork 557
Coding Guidelines
Fluid Framework does not strictly enforce any coding guidelines today, beyond our configuration of ESLint. Please aim for consistency with the existing code, which loosely adheres to the Coding Guidelines for TypeScript.
One notable exception to the TypeScript guidelines is that we do prefer the I prefix for types which correspond to abstractions for objects which have private internal state that is interacted with through that abstraction. This does not include classes but can include some (but not all) types declared with interface or type.
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