dbt-project-evaluator icon indicating copy to clipboard operation
dbt-project-evaluator copied to clipboard

Naming Conventions: Folder vs Directory

Open patkearns10 opened this issue 2 years ago • 0 comments

Describe the bug

I noticed we use subfolder and subdirectory rather interchangeably. Should we standardize on one? If so, which?

internet says:

If one is referring to a container of documents, the term folder is more appropriate. The term directory refers to the way a structured list of document files and folders is stored on the computer. It is comparable to a telephone directory that contains lists of names, numbers and addresses and does not contain the actual documents themselves. source

Steps to reproduce

current counts in readme:

folder = 24 subfolder = 2

directory = 58 subdirectory = 34

We have fields named:

  • directory
    • directory_path
    • child_directory_path
    • parent_directory_path
    • test_yml_directory_path
    • model_directory_path
    • current_test_directory
    • change_test_directory_to
  • path
    • file_path
    • current_file_path
    • change_file_path_to
    • parent_file_path
    • child_file_path

We have variables named:

  • staging_folder_name
  • intermediate_folder_name
  • marts_folder_name

We have models named:

  • stg_naming_convention_folders
  • fct_model_directories
  • fct_source_directories
  • fct_test_directories

Expected results

Stick to one or the other, or be conscious of the decision if we do use both

patkearns10 avatar Jun 01 '22 01:06 patkearns10