File Management Guidelines

Programming Language Test Files

  1. All programming language test files goes into folder named in the following convention: "python-test1", "python-test2" , except for the case in ruling 2 given below.
  2. The folder naming of the specialized test files should reflect the objective of the test, for example: "stdnlp-test"

Example files and Temp files

  1. Temp files and example files should go into waffle, apollo, and zeus project source tree when they are needed to be versioned.
  2. Temp files should be periodically moved into one target folder or removed.
  3. Example files should be periodically moved into the example project source tree: coding-examples

Tutorial Folder and Examples Folder

  1. Repositories hosting tutorial projects designated to a specific topic should be named xxxx-tutorial.
  2. Repositories hosting loosely organized example files should be named xxxx-examples


No upper-case char should appear in project name and file names. Dash is allowed in project name, underscore is allowed in file name.

  1. Python
    modulename/module_name, packagename, ClassName, method_name, ExceptionName, function_name, GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, function_parameter_name, local_var_name

  2. Java
    FileName, packagename, ClassName, methodName, CONSTANT_NAME, localVarName, fieldName, parameterName, TypeVarName (T, single char)

  3. C/C++
    file_name, foldername, local_var_name, ClassName, FunctionName, class_data_member_, struct_data_member

Leave a Reply

Your email address will not be published. Required fields are marked *