github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/contirubting: clarify the type of changelog line we expect

Browse source 
Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
hagen1778 2024-10-17 11:59:55 +02:00 committed by Zakhar Bessarab
parent 7b49d4f5dc
commit 75bd8a19e6
No known key found for this signature in database
GPG key ID: 932B34D6FE062023
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/CONTRIBUTING.md
View file

@ -64,7 +64,8 @@ A pull request should contain the following attributes:
1. Try to not extend the scope of the pull requests outside the issue, do not make unrelated changes.
1. Documentation update, if needed. For example, adding a new flag or changing behavior of existing flags or features
requires reflecting these changes in the documentation.
1. A line in the [changelog](https://docs.victoriametrics.com/changelog/#tip) mentioning the change and related issue.
1. A line in the [changelog](https://docs.victoriametrics.com/changelog/#tip) mentioning the change and related issue in a way
that would be clear to other readers even if they don't have the full context.
1. Reviewers who you think have the best expertise on the matter.
See good example of pull request [here](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6487).