We need a structure to our naming conventions, or namespaces if i may.
Criteria:
- Use ISO standards when possible
- Namespace in Reverse Domain Name Notation according to the standards of the framework used. Excluding the TLD (.com, .net, .org) component is often recommended
- Our standard date format is YYYY-MM-DD for ultimate sorting purposes
- Our standard currency is USD
Project Directories:
- The webroot should always be a subdirectory of the project root, typically called
web
- The project should follow best practices for the framework used
- When not defined, a directory structure should try to look like:
- project root
web
assets
css
- a bunch of compiled files you never edit
sass or scss
- the actual files you edit to generate the css, sass is preferred over scss
- for complex projects, a styles directory structure may be necessary
_includes
_fonts
_mixins
- etc, if you're worried about structuring your css, you're ready to do some research on it
js
- local script files only, integrations should be included through npm includes, or through single directory components for Drupal
- build files
vendor directory
- local cache artifacts
We need a structure to our naming conventions, or namespaces if i may.
Criteria:
Project Directories:
webwebassetscsssassorscss_includes_fonts_mixinsjsvendordirectory