Dev Guidelines

Simple guidelines for various Dev tasks.

Featured image for Dev Guidelines

CMS Form Guidelines

Simple guidelines for setting up EE fields for easy CMS use:

  • Field Names should be descriptive
    • More generic if in fluid
    • If specific use, be more specific
  • Every field needs instructions
    • Describe the field or how it's used, maybe even what it looks like, any special instructions
    • Every image field needs dimensions Ex: "Images should be sized at least 400x400." Base it off the biggest manipulation used for the section
  • Minimum Width for Grid Fields (if field is squished):
    • Text Boxes - 150px
    • Basic Wygwam - 400px
    • Full Wygwam - 600px
    • Textarea - 400px
  • File fields should be connected to a directory (with manipulations)
  • Image manipulations for every directory (except for maybe Content directory)
    • By default, use the image from the design as a guide
    • Adjust these based on how good the image looks when displayed

Template Notes Guidelines

The following are guidelines when using the Template Notes feature for leaving nice, clean, and descriptive notes:

  • Start with Capital, no period at the end
  • Proper capitalization, punctuation throughout (Ex: 'XML' should be capitalized)
  • Note should answer What was changed, possibly Why, not How
  • Write the Note as if you were finishing this sentence: "In this template, I..."