Browse Source

Files and Folders naming conventions

singulart 3 years ago
parent
commit
2e6dd21253
1 changed files with 21 additions and 0 deletions
  1. 21 0
      governance/Files_and_Folders_Naming_Rules.md

+ 21 - 0
governance/Files_and_Folders_Naming_Rules.md

@@ -0,0 +1,21 @@
+
+# Community Repo Files and folders naming rules
+
+v1.0
+
+## Folders
+
+Folders should generally be named in lower case characters, with '-' as words separator. In other words, in lower kebab case: `example-folder-in-lower-kebab-case`
+
+
+## Files
+
+For regular files, the general rule should be to use lower snake case: `lower_Snake_Case`. Uppercase is allowed, as well as numbers.
+
+Not recommended to use:
+1. Spaces
+2. Non-English characters
+3. Characters used in URLs: #, &, ?, :, /
+
+
+These naming conventions can be overruled by the specific requirements dictated by respective software tools or libraries that a contributor choses to use for their coding contributions.