-
Notifications
You must be signed in to change notification settings - Fork 536
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 any interface that is intended to be extended or implemented. Types intended for use as data contracts, even if declared with the interface keyword, should not be prefixed with I. Note that this guidance is not followed perfectly within the codebase today, but please adhere to it going forward.
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