From 5e5de6be9a2c57688fd20f906a609a62a22e7da6 Mon Sep 17 00:00:00 2001 From: Artem Navoiev Date: Sun, 28 Jul 2019 20:39:46 +0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..4a121902b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +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.