mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-23 20:37:12 +01:00
c006db1798
* add pull request template Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * update text Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * update text Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * Update .github/PULL_REQUEST_TEMPLATE/pull_request_template.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * Update .github/PULL_REQUEST_TEMPLATE/pull_request_template.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * update messaging add example Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * docs/contributing: add info about mandatory requirements before sending a PR Added the following info: - commits signing / sign-off - how to run tests / linting with make commands Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Artem Navoiev <tenmozes@gmail.com> Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Artem Navoiev <tenmozes@gmail.com> Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
22 lines
1.4 KiB
Markdown
22 lines
1.4 KiB
Markdown
If you like VictoriaMetrics and want to contribute, then we need the following:
|
|
|
|
- Filing issues and feature requests [here](https://github.com/VictoriaMetrics/VictoriaMetrics/issues).
|
|
- Spreading a word about VictoriaMetrics: conference talks, articles, comments, experience sharing with colleagues.
|
|
- Updating documentation.
|
|
|
|
We are open to third-party pull requests provided they follow [KISS design principle](https://en.wikipedia.org/wiki/KISS_principle):
|
|
|
|
- Prefer simple code and architecture.
|
|
- Avoid complex abstractions.
|
|
- Avoid magic code and fancy algorithms.
|
|
- Avoid [big external dependencies](https://medium.com/@valyala/stripping-dependency-bloat-in-victoriametrics-docker-image-983fb5912b0d).
|
|
- Minimize the number of moving parts in the distributed system.
|
|
- Avoid automated decisions, which may hurt cluster availability, consistency or performance.
|
|
|
|
Adhering `KISS` principle simplifies the resulting code and architecture, so it can be reviewed, understood and verified by many people.
|
|
|
|
Before sending a pull request please check the following:
|
|
- [ ] All commits are signed and include `Signed-off-by` line. Use `git commit -s` to include `Signed-off-by` your commits. See this [doc](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) about how to sign your commits.
|
|
- [ ] Tests are passing locally. Use `make test` to run all tests locally.
|
|
- [ ] Linting is passing locally. Use `make check-all` to run all linters locally.
|