Skip to content

Commit 06fe4b7

Browse files
author
Šarūnas Navickas
committed
A small documentation on contribution
1 parent 56f7627 commit 06fe4b7

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
New agents
2+
==========
3+
Most natural way of contributing to this project is creating new agents.
4+
What is agent? It is basically a metrics collector for specific service,
5+
eg. `oshino-redis` is an agent which runs `info` command as a Redis client,
6+
parses received metrics and gives them to `oshino` as events.
7+
8+
To make life easier, there's a `cookiecutter` template (oshino-cookiecutter)[https://github.com/CodersOfTheNight/oshino-cookiecutter]
9+
which generates all boilerplate code, you just need to modify it.
10+
11+
Already existing custom agents are mostly listed here: (Third party Agents)[https://github.com/CodersOfTheNight/oshino/blob/master/docs/thirdparty.md]
12+
13+
Contributing to the Core
14+
========================
15+
It should mostly consist of reporting/solving issues.
16+
17+
General Guidelines
18+
===================
19+
- Code must pass `flake8` (PEP8) coding style test
20+
- All code (with few exceptions) must be non-blocking - asyncio compatible
21+
- New parameters should be covered in documentation section

0 commit comments

Comments
 (0)