Show Menu

Relaymed Developer Guidelines Cheat Sheet by

Guidelines on codeing standard and naming conventions within Relaymed.Also includes information on other things on lifecycle etc.
internalguidelines

Main Guidelines

Files should be grouped together by type
We should only have one class per file.
Anything that is in more than one project should be in the common projects.
We shouldn't use the word message in any name of any object. Use DTO/Entity
Namespaces should begin with Rela­ymed.

Site Dev Guidelines

Drop domain objects in the service fa├žade - Site should just be a UI onto of the Relaymed Service
No Comman­ds/­Queries -> if you touch any code with one, remove it
Site should just have view/S­ervice Contra­ct/­Con­tro­llers - all else will be removed eventually
Don't call the context directly from the service contract (should have Service Layer | Repository | Data Context)
Do not use the Device Payload anywhere
Site should not access a Database directly
Domain Objects should have proper constr­uctors for mandatory proper­ties, not auto-p­rop­erties. Auto properties should only be used for optional properties
Do not use Valid files in testing, use builders and construct test data properly
Model Validation should be done on server, JS can be used as a progre­ssion enhanc­ement but only that
 

Naming Conven­tions

MVC Model
Should contain Business logic
 
*Vie­wMo­del
pass into the views from the controller to render (DTO), can be a list. NO LOGIC
*Ent­ity
Interacts with the database layer
OFFSET­_FR­OM_­TOP­_OF­_PAGE
Constants
the­Te­stC­las­sFo­rDC­AVa­ntage
Class Names for Unit Tests
shou­ld_­g­et_­pat­ien­t_t­est­s_t­hat­_ar­e_n­ot_­fin­ished
Individual Test Name
the­Te­stC­las­sFo­rDC­AVa­nta­ge_­set­upTests
Methods to Extend the Test Class
_m­emb­er&In­sta­nce­Var­iables
lowercase camelCase
EHR
Acronyms Should be Upper Case
AddPay­loa­dBl­obC­olumn
Migrations should be Upper CamelCase
Shows the naming conven­tions for Relaymed C# code. Parts in bold must be included in that form, normal text should be replaced with meaningful names.

Download the Relaymed Developer Guidelines Cheat Sheet

1 Page
//media.cheatography.com/storage/thumb/marryat_relaymed-developer-guidelines.750.jpg

PDF (recommended)

Alternative Downloads

Share This Cheat Sheet!

 

Comments

gregg.flynn gregg.flynn, 15:13 18 Feb 14

* Defined (D) - description says ", but" then nothing...
* Namespaces should *being* with RelayMed

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          Related Cheat Sheets

          Relaymed & Rally Cheat Sheet

          More Cheat Sheets by Marryat

          Relaymed & Rally Cheat Sheet