diff --git a/docs/code/developer-workflows.md b/docs/code/developer-workflows.md index cc4ac786d..305158ca7 100644 --- a/docs/code/developer-workflows.md +++ b/docs/code/developer-workflows.md @@ -6,7 +6,14 @@ This guide covers commit conventions, pull request guidelines, and labeling work This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages and pull request titles. -Format: `: ` +Format: `[optional scope][optional !]: ` + +To signal a **breaking change**, append `!` after the type (and scope, if present): + +``` +feat!: remove deprecated editor bridge method +fix(api)!: change block serialization format +``` Common types: @@ -45,5 +52,6 @@ PRs are automatically labeled based on the Conventional Commits prefix in the ti | `docs` | `[Type] Developer Documentation` | | `build`, `ci` | `[Type] Build Tooling` | | `refactor`, `task`, `chore`, `style` | `[Type] Task` | +| any type with `!` | `[Type] Breaking Change` | If you manually apply a type label before the automation runs, your choice is respected — the workflow skips re-labeling when a conflicting type label is already present. diff --git a/docs/releases.md b/docs/releases.md index 2ee72017d..4b0118b27 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -43,9 +43,10 @@ After the release is created, it is ready for integration into the WordPress app GitHub automatically generates release notes when a release is created. Notes are organized into the following categories based on PR labels: +- **Breaking Changes** — `[Type] Breaking Change` - **Features & Enhancements** — `[Type] Enhancement` - **Bug Fixes** — `[Type] Bug`, `[Type] Regression` -- **Other Changes** — everything else +- **Other Changes** — everything else (excludes `[Type] Automated Testing`, `[Type] Build Tooling`, `[Type] Task`, `[Type] Developer Documentation`, and `dependencies`) Dependabot dependency bump PRs are excluded automatically.