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/CONTRIBUTING.md: small corrections after a402847eb6

Browse source
This commit is contained in:
Aliaksandr Valialkin 2024-04-20 23:21:42 +02:00
parent a402847eb6
commit d18968f8cb
No known key found for this signature in database
GPG key ID: 52C003EE2BCDB9EB
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/CONTRIBUTING.md
View file

@ -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: 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?
- Why this change is needed? - Why this change is needed?
The change description must link to related GitHub issues and the related docs, if any. The change description must link to related GitHub issues and the related docs, if any.
Tips for writing a good changelog message: Tips for writing a good changelog message:
- Write a human-readable changelog message that describes the problem and the solution. - 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. - 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 related GitHub issue or pull request.
- Provide a link to the relevant documentation for any new features you add or modify. - 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. - [ ] 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). [Here is an example](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4048#issuecomment-1546453726).