Skip to content

Naming Conventions

edmistj edited this page Nov 21, 2012 · 11 revisions

When you write custom stuff please adhere to the rules below to avoid collisions with other developer's stuff. Below you'll see reference to your organization's OID. This means - some unique string such as your organization's name, acronym or domain name.

Examples: Moz – for Mozilla, JordanRift or JRift – for Jordan Rift, CCV – for Christ's Church of the Valley

Custom Tables

Custom tables should be prefixed with an underscore followed by your such as: _mozTable1 or _ccvTableXYZ

Custom Classes

We strongly recommend you place your custom code into a Rock.Custom.<OID> namespace such as Rock.Custom.CCV.Api or Rock.Custom.JordanRift.App1

Custom API

When developing custom API extensions, developers must use a folder convention api/<com.domain>/ (such as api/com.ccvonline/) to avoid collisions with other custom developer APIs.

Clone this wiki locally