From 88c684e1d03fdc64dcb69ddc9736f9d807d57b53 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Sun, 12 Nov 2017 14:10:16 +0100 Subject: [PATCH] README.md: document procedure for breaking changes --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 030db1e..afaf591 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,13 @@ Make sure to develop an understanding how zrepl is typically used by studying th * Commits should reference the issue they are related to * Docs improvements not documenting new features do not require an issue. +### Breaking Changes + +Backward-incompatible changes must be documented in the git commit message and are listed in `docs/changelog.rst`. + +* Config-breaking changes must contain a line `BREAK CONFIG` in the commit message +* Other breaking changes must contain a line `BREAK` in the commit message + ### Glossary & Naming Inconsistencies In ZFS, *dataset* refers to the objects *filesystem*, *ZVOL* and *snapshot*.