[DOC] add hint on FIXME tag

Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
14 years ago · e5d8843edd
parent e4390da300
commit e5d8843edd
1 changed files with 5 additions and 0 deletions
--- a/doc/man/man7/cdist-hacker.text
+++ b/doc/man/man7/cdist-hacker.text
@ -27,6 +27,11 @@ read the scripts bin/cdist-deploy-to calls. The magnificent HACKERS_README
 may be of great help as well.


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