From f5c20e9c9b46ac6efe3c3948302e4e20718a5968 Mon Sep 17 00:00:00 2001 From: Heikki Kallasjoki Date: Tue, 4 Dec 2018 23:26:01 +0000 Subject: Documentation improvements. Include OpenWrt feed and installation instructions, as well as more details (and a README link) on how to contribute to the project. --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 939e534..c1aba62 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,26 @@ use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests. +## Code style, structure & principles + +Please keep consistent with the existing code style, which is inspired +by (the non-C++-specific parts of) the [Google C++ Style +Guide](https://google.github.io/styleguide/cppguide.html), with a few +exceptions: no mixed-case names, and a 100-character line length +limit. + +The goal of the project is to be lightweight and have no large +external dependencies. If you wish to add a collector that inherently +depends on a library, it should be optional to the build, and probably +not included by default. + +All exported metrics should be related to the node (host, machine...) +the exporter is running on, not to any specific service running on +it. Services should optimally export their own metrics natively, or +via an exporter specific to the service. Alternatively, you might be +interested in [mtail](https://github.com/google/mtail), which extracts +monitoring data from log files. + ## Community Guidelines This project follows [Google's Open Source Community -- cgit 1.4.1