To have a basic understanding on the code review process, and how to enhance the Content Author'e experience while managing the content. This presentation was given to my colleagues.
2. WWW.GOPIGUJJULA.COM
AGENDA
• To have a better understanding on, what will be reviewed in the code-review process.
• Using this checklist, Individual engineer can self review, before submitting for code review.
• Will look into basic points to check on both Sitecore as well as code.
COPYRIGHT 20162
4. WWW.GOPIGUJJULA.COM
TEMPLATE
• Template Icons help to visually separate semantically related content items.
• Importance of Source for list fields (ex: Multi list, or Tree list etc.)
ex: DataSource=/sitecore/content/testsite/Global/Components/Data/Categories
StartSearchLocation={88BF8A46-93AC-4604-BC50-DF03FC451504}&Filter=_templatename:Tag
DF03FC451504}&Filter=_templatename:Tag
COPYRIGHT 20164
9. WWW.GOPIGUJJULA.COM
CONTENT
• Content Item – name should be appropriate and try to match the content with designs (very
important while giving demo).
• Item presentation (Data sources on Shared layout or Final layout).
COPYRIGHT 20169
10. WWW.GOPIGUJJULA.COM
EXPERIENCE EDITOR
• Sitecore does not support in-line editing for Checkbox, Multilist, TreeList, and other fields, to
enable this
• Utilize Edit Frame/Field editor buttons for editing item fields not rendered by the
FieldRenderer.
• We can find all this buttons in core database, under the
/sitecore/Content/Applications/WebEdit item.
COPYRIGHT 201610
12. WWW.GOPIGUJJULA.COM
CODE
• Aggressive Null checks at all the levels.
• In partial classes, always prepend the custom property names with ‘Custom_’. This will group together all the
custom properties in the intellisense and make things easier for the developer.
• Always use glass mapper HTML helpers to render the field values. Field renderer provides ability of editing the
field value using Experience Editor.
• Do not put any static text in views, always get it from dictionary.
• Be careful on GUID comparisons.
• Avoid hard coding GUID, read from either TDS generated classes, or app settings.
• All rich text fields rendered must be wrapped within a @Html.Raw.
• If there is no data source or values, do not render any HMTL.
COPYRIGHT 201612
13. WWW.GOPIGUJJULA.COM
OTHERS
• In local environment, create your own Sitecore credentials to use, and avoid using default
Admin/b account.
• In Package designer, whenever packaging any Sitecore items, try to mention the Author
name.
• Aggressive website testing on mobile break point, & Sitecore in Experience editor.
• Field level validations – ex: Max chars, or single item selection.
COPYRIGHT 201613