From 6f9f861f5790a78d58eca20322be4e40144d2bb0 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 17 Jul 2024 11:46:21 +0200 Subject: [PATCH] docs/CONTRIBUTING.md: mention that docs/CHANGELOG.md shouldn't contain technical details for the changes The purpose of docs/CHANGELOG.md is to provide VictoriaMetrics users clear and concise information on what's changed at VictoriaMetrics components. Technical details of the change are unclear to most of VictoriaMetrics users, who are not familiar with VictoriaMetrics source code. These details complicate reading the docs/CHANGELOG.md by ordinary users, so do not clutter the changelog with technical details. If the user wants technical details, he can click the link to the related GitHub issue and/or pull request and dive into all the details he wants. --- docs/CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d058374a9..e266b09f8 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -49,7 +49,8 @@ Further checks are optional for external contributions: - The change must be described in **clear user-readable** form at [docs/CHANGELOG.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md), since it is read by **VictoriaMetrics users** who may not know implementation details of VictoriaMetrics products. The change description must **clearly** answer the following questions: - - What does this change do? + + - What does this change do? There is no need to provide technical details for the change, since they may confuse VictoriaMetrics users, who do not know Go. - Why this change is needed? The change description must link to the related GitHub issues and the related docs, if any.