You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by sr...@apache.org on 2021/02/11 20:32:52 UTC
[superset] branch master updated: Added a note about the ! prefix
for breaking changes to CONTRIBUTING.md (#13083)
This is an automated email from the ASF dual-hosted git repository.
srini pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new 870886c Added a note about the ! prefix for breaking changes to CONTRIBUTING.md (#13083)
870886c is described below
commit 870886ca2f8a1860ca9e42a8c052ecf2d48cd7d6
Author: Robert H Stolz <71...@users.noreply.github.com>
AuthorDate: Thu Feb 11 12:31:55 2021 -0800
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 c4e54d6..ddcc860 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.