Conventions

Jump to bottom

vagelim edited this page Jun 19, 2015 · 4 revisions

GitHub/commit titles

Every commit title, PR or issue should be named like the following example:

[category] short description of the matter

category can be:

core: for the agent internals, or the common interfaces
dogstatsd: for the embedded dogstatsd server
tests: related to CI, integration & unit testing
dev: related to development or tooling
check_name: specific to one check

For descriptions, keep it short and meaningful. Here are few examples to illustrate.

Bad descriptions

[mysql] mysql check does not work
[snmp] improved snmp
[core] refactored stuff

Good descriptions

[mysql] exception ValueError on mysql 5.4
[snmp] added timeouts to snmpGet calls
[core] add config option to common metric interface