From d18968f8cb7b6138651c5c491022dc85ff32681a Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Sat, 20 Apr 2024 23:21:42 +0200 Subject: [PATCH] docs/CONTRIBUTING.md: small corrections after a402847eb6cd51fa94a2e7e11113d5037397a3aa --- docs/CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e3e85a23b..8008932cc 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -57,14 +57,15 @@ Further checks are optional for External Contributions: 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? - Why this change is needed? + The change description must link to related GitHub issues and the related docs, if any. Tips for writing a good changelog message: - Write a human-readable changelog message that describes the problem and the solution. - Use specific text, which can be googled by users interested in the change, such as an error message, metric name, command-line flag name, etc. - - Include a link to the issue or pull request in your changelog message. - - Provide a link to the relevant documentation for any new features you add or modify. + - Provide a link to the related GitHub issue or pull request. + - Provide a link to the relevant documentation if the change modifies user-visible behaviour of VictoriaMetrics producs. - [ ] After your pull request is merged, please add a message to the issue with instructions for how to test the fix or try the feature you added before the new release. [Here is an example](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4048#issuecomment-1546453726).