From b7eb0670907637ab2a9c0f40dfe5dc46eb7efbe0 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Thu, 20 Oct 2022 19:19:43 +0100 Subject: [PATCH] Added the emphasize changelog (#79160) Co-authored-by: Sviatoslav Sydorenko --- docs/docsite/rst/community/collection_development_process.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docsite/rst/community/collection_development_process.rst b/docs/docsite/rst/community/collection_development_process.rst index afe693a265e..2da39649255 100644 --- a/docs/docsite/rst/community/collection_development_process.rst +++ b/docs/docsite/rst/community/collection_development_process.rst @@ -46,6 +46,8 @@ We do not merge every PR. See :ref:`collection_quickstart` for tips to make you Creating changelog fragments ----------------------------- +Most changelogs should emphasize the impact of the change on the end user of the feature or collection, unless the change impacts developers directly. Consider what the user needs to know about this change and write the changelog to convey that detail. + Changelogs help users and developers keep up with changes to Ansible collections. Many collections build changelogs for each release from fragments. For collections that use this model, you **must** add a changelog fragment to any PR that changes functionality or fixes a bug. You do not need a changelog fragment for PRs that: