From 870886ca2f8a1860ca9e42a8c052ecf2d48cd7d6 Mon Sep 17 00:00:00 2001 From: Robert H Stolz <7143905+garden-of-delete@users.noreply.github.com> Date: Thu, 11 Feb 2021 12:31:55 -0800 Subject: [PATCH] Added a note about the ! prefix for breaking changes to CONTRIBUTING.md (#13083) --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4e54d624f..ddcc860ae9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -222,6 +222,7 @@ Finally, never submit a PR that will put master branch in broken state. If the P - `fix(chart-api): cached-indicator always shows value is cached` - Add prefix `[WIP]` to title if not ready for review (WIP = work-in-progress). We recommend creating a PR with `[WIP]` first and remove it once you have passed CI test and read through your code changes at least once. +- If you believe your PR contributes a potentially breaking change, put a `!` after the semantic prefix but before the colon in the PR title, like so: `feat!: Added foo functionality to bar` - **Screenshots/GIFs:** Changes to user interface require before/after screenshots, or GIF for interactions - Recommended capture tools ([Kap](https://getkap.co/), [LICEcap](https://www.cockos.com/licecap/), [Skitch](https://download.cnet.com/Skitch/3000-13455_4-189876.html)) - If no screenshot is provided, the committers will mark the PR with `need:screenshot` label and will not review until screenshot is provided.