document how to report bugs

Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2011-04-06 22:13:30 +02:00
parent b0391ac0c9
commit d39457b0a7

View file

@ -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 (__)