Code requirements and standards #

We should follow bestpractice when build our code. All code should be placed in control version system.

Name convension #

We should setup new short project code. Usually this is 2-4 letters. For example XXX.

New objects and part of objects (fields, indexes and so on) should has this prefix.

Create new model #

Model name: XXX_Extensions Model publisher: SIS Layer: var Version: 1.0.0.0 Model Description: This model will contain all the extensions created specifically for XXX Model Display name: XXX_Extensions

Label file: XXX_Extensions_en-US

Extensions #

For extended object we should use _Extension suffix Also we should include name of extended object to the class name

Example: XXXProjInvoiceTableProjFoundingSourceDS_Extension

Handlers #

For handlers we should use _EventHandler suffix Also we should include name of hadled object to the class name

Example: XXXPurchReqCreateFormDSFldChangeOrder__EventHandler

Project Name #

XXX_TaskCode_ProjectName

Change set name #

Dev Change sets #

Change sets best practice it is to give human understandable description for each change set. Good to have item Id in description part. For example XXX_123456_InventoryReportChanges, where:

XXX - client project code ID
123456 - ticket number from tracking system (Azure DevOps for example)
InventoryReportChanges - human readable description

Also for each change set need to add link to existing code of tracking system

Not allow to have any kind of errors in change set.

All changesets should have task number in description, also task number should selected in Related work items section

NonDev Changesets #

Examples:

TD: SIS, VH 09/02/2022 Merge Main-Dev to Main-Test: 87257: SISTD_87257_POTaskCodeLookup
Ameresco: 337563:  AME_265760_ ModifyWorkflowtables_LastWorkflowMessageonPRlist, alexK (Test)
Hermanson: Test - 250801 fast tab calculates first line - DevTest ChangeSet 22960