#SUGDE The good, the bad and the ugly Sitecore module

Unsichtbare Technologie. Sichtbare Kreativität. netzkern.

27. Oktober 2015

The Good, The Bad and The Ugly Sitecore Module


Agenda

1. Intro

2. Architecture Best Practices

3. Recommendations

4. Clean Code


Intro


About me

Maksym Ponomarenko

Sitecore Consultant

netzkern AG


Paraphrasing classic

There are two kinds of Modules in the world, my friends:

- With Flexible Architecture

- Ugly


Architecture Best Practices


Pipelines and Processors


Managers and Providers


ID Generator


Logs


Clean Code


Understanding messy code

Developer spends 60-80% time in understanding code

Messy code is a significant impediment


Megamoth

Never make Mega Monolytic Methods

Don‘t build God classes

Write short methodsand

Class should have only one reason


Clean Code

“Clean code can be read, and enhanced by a developer other

than its original author. “

"Big" Dave ThomasFounder of OTI, godfather of the Eclipse strategy


Use S.OL.I.D principles

Single responsibilityOpen-closedLiskov substitutionInterface segregationDependency inversion


Design Stamina Hypothesis


Hell


Recommendations


Recommendations

Module should be well docummented

1. Instalation Guide

2. User Guide

3. Developer Guide


Recommendations

Do not override standard Sitecore functionalities


Recommendations

Do not depend on other modules


Recommendations

Support CM-CD environment


Recommendations

Do not forget about localization

Translate.Text("LoremIpsum");


Recommendations

Move Settigns to items


Recommendations

Provide a Sitecore Speak Application to configure your module


Your project can be supported by a violent gunman who knows how to find you

Remember


Vielen Dank für Ihre

Aufmerksamkeit.

#SUGDE The good, the bad and the ugly Sitecore module

Technology

Transcript of #SUGDE The good, the bad and the ugly Sitecore module