5 Design Goals

Sam Broner редактировал(а) эту страницу 2020-06-18 11:45:14 -07:00

Содержание

• Introduction
• Goals

Introduction

This page describes the general design goals of the Fluid Framework. Its purpose is to provide some background on certain design decisions and describe the general thinking for the codebase. It is by no means definitive or exhaustive. Each part of the Fluid Framework, client components, distributed data structures (DDSs), hosts & loaders, back-end servers, etc. each deserve their own design-goals document. These are, however, good general guidelines to have in mind and consider while introducing any changes.

Goals

1. Create modular, reusable pieces of client component code that update in a synced, real-time manner
2. Be platform agnostic. Fluid Framework should work with any data storage provider, rendering framework, and platform.
3. Have an extremely lightweight, easy-to-deploy backend server to relay messages amongst clients
4. Handle all ordering logic for real-time functionality on individual clients, not the server
5. Abstract complex real-time logic from client view code using generic, multi-purpose DDSs
6. Define clean interfaces for components to interact among one another, and respect component logic abstraction. A component should not refer to another component's inner DDSs.
7. Be easy to develop on. Onboarding to Fluid should require minimal initial setup, and tooling should be available to readily create new components.

Overview

• Wiki Home
• Usage Documentation (fluidframework.com)
• FAQ (fluidframework.com)

Contributing

• 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
    • API Type Validation
    • Communicating Breaking Changes
    • Changesets
  • Branches, Versions, and Releases
  • Compatibility & Versioning
  • Testing
    • Bundle Size Tests
  • Debugging
  • npm package scopes
  • Maintaining API support levels
  • Developer Tooling Maintenance
  • API Deprecation
  • Working with the Website (fluidframework.com)
    • Building Documentation Locally
• Coding Guidelines
• Documentation Guidelines
  • Where To Put Documentation
  • Documentation Dos and Don'ts
  • Fluid Terminology
  • Documenting TypeScript
    • TSDoc Guidelines
    • Release Tags
  • Documenting JavaScript
  • Markdown Best Practices
• CLA

Using Fluid Framework

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.