X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Ftest_code_guidelines.rst;h=24544b93de697ab616a849fe17172d7eeceb9045;hp=51a99f077a06835933141820f7b54aff9430faf3;hb=130c7fc821fca1fea4c5d4ff68c38e4a8cf2772d;hpb=4e92926132e55972a956be7b854e6e698c62857a diff --git a/docs/test_code_guidelines.rst b/docs/test_code_guidelines.rst index 51a99f077a..24544b93de 100644 --- a/docs/test_code_guidelines.rst +++ b/docs/test_code_guidelines.rst @@ -284,7 +284,7 @@ and unrelated ones such as PAL) if there are any (in addition to library ones). + It is NOT RECOMMENDED to use hard-coded constants (e.g. numbers, paths without any description). It is RECOMMENDED to use - configuration file(s), like /csit/resources/libraries/python/constants.py, + configuration file(s), like /csit/resources/libraries/python/Constants.py, with appropriate comments. + The code SHALL log at the lowest possible level of implementation, @@ -319,4 +319,4 @@ and unrelated ones such as PAL) if there are any (in addition to library ones). Bash scripts and libraries ~~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO: Link here when document for this is ready. +TODO: Link or copy the bash_code_style.rst document here.