From e1458e6a358f8d2f32196a2a8ea6bbac973e2e7b Mon Sep 17 00:00:00 2001 From: Jeremy Lecour Date: Thu, 4 Feb 2021 11:13:05 +0100 Subject: [PATCH] Mention the CHANGELOG in the README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e2094277..03588208 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,8 @@ Before starting anything of importance, we suggest contacting us to discuss what Our conventions are available in the "ansible-public":https://gitea.evolix.org/evolix/ansible-public repository, in the CONVENTIONS.md file. +All modifications should be documented in the CHANGELOG file, to help review releases. We encourage atomic commits, on a single role, and with the CHANGELOG in the same commit. + ## Workflow The ideal and most typical workflow is to create a branch, based on the "unstable" branch. The branch should have a descriptive name (a ticket/issue number is great). The branch can be treated as a pull-request or merge-request. It should be propery tested and reviewed before merging into "unstable".