Содержание
Note: this is currently only enforced for the build-tools release group. But you can follow this style elsewhere!
We use the conventional commit format in the build-tools release group. This lets us autogenerate changelogs and more easily write release notes.
Because we use the "squash merge" workflow for most of our branches, the PR title and body become the commit title and message, respectively. For this reason, we run a required check in CI that verifies PR titles adhere to the standard as configured in the repo.
The format
The conventional commits format looks like this:
type(scope?): subject #scope is optional but recommended; multiple scopes are supported
Valid types are:
TODO
For scope, use the following:
TODO
PR template content
Our PR template contains sections that are meant to be removed. We check that these sections are not in the PR message.
Overview
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
- 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
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.