Revision 50a76a38
Added by Alexis Mousset about 7 years ago
| 8_reference/73_techniques_best_practices.txt | ||
|---|---|---|
|
* All the bundles should have as first argument "prefix" which contains the prefix to use for all the classes made from an outcome. This prefix should never be hardcoded in the bundle.
|
||
|
* Always write comments with # when a promise needs more than 30 seconds of thought.
|
||
|
* If classes should be created in order to iterate for make a workaround of the normal ordering (i.e: "iteration_1", "iteration_2", "iteration_3"), they should always be defined at the end of the promise type "classes".
|
||
|
* The order to the promise type must always be in the order of the normal ordering : https://docs.cfengine.com/lts/guide-language-concepts-normal-ordering.html
|
||
|
* The order to the promise type must always be in the order of the normal ordering : https://docs.cfengine.com/docs/3.10/reference-language-concepts-normal-ordering.html
|
||
|
* StringTemplate variables should always be written in UPPERCASE
|
||
|
* StringTemplate variables should be written with underscore
|
||
|
* StringTemplate variables should always be prefixed by the Technique name in uppecase too. i.e: `CHECK_GENERIC_FILE_FILE_NAME`
|
||
Also available in: Unified diff
Fixes #10151: Broken link in CFEngine doc