From ecdc43adcc971dc15df7d9385b29e4e2a23489b1 Mon Sep 17 00:00:00 2001 From: Gunnar Morling Date: Thu, 7 Apr 2022 10:54:32 +0200 Subject: [PATCH] [docs] Updating contribution guide for usage of [docs] prefix --- CONTRIBUTE.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 2ff7722a8..7b4ef0227 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -151,6 +151,14 @@ to the database and use logical decoding to read the transaction log. Several ne integration test were added. ``` +As an exception, commits for trivial documentation changes which don't warrant the creation of a Jira issue can be prefixed with `[docs]`, for example: + +``` +[docs] Typo fix in Postgres connector documentation +``` + +The following commit message prefixes are reserved for internal usage by the Debezium CI infrastructure and should not be used in manually created commits: `[release]`, `[jenkins-jobs]`, `[maven-release-plugin]`, and `[ci]`. + ### Code Formatting This project utilizes a set of code style rules that are automatically applied by the build process. There are two ways in which you can apply these rules while contributing: