From d39457b0a740bff5f2059b9344887d62939a1c01 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Wed, 6 Apr 2011 22:13:30 +0200 Subject: [PATCH] document how to report bugs Signed-off-by: Nico Schottelius --- doc/man/man7/cdist-hacker.text | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/man/man7/cdist-hacker.text b/doc/man/man7/cdist-hacker.text index 27f92a4a..f9f08e31 100644 --- a/doc/man/man7/cdist-hacker.text +++ b/doc/man/man7/cdist-hacker.text @@ -19,6 +19,13 @@ twice before merging or implementing a feature: Less features with good usability are far better than the opposite. +REPORTING BUGS +-------------- +If you believe you've found a bug and verified that it is +in the latest version, drop a mail to the cdist mailing list, +subject prefixed with "[BUG] ". + + UNDERSTANDING CDIST INTERNALS ----------------------------- IF you are interested in how cdist internally works, you can open @@ -32,6 +39,7 @@ CODING CONVENTIONS (EVERYWHERE) If something should be better done or needs to fixed, add the word FIXME nearby, so grepping for FIXME gives all positions that need to be fixed. + CODING CONVENTIONS (CORE) ------------------------- - All variables exported by cdist are prefixed with a double underscore (__)