Professional Developer Guidelines

This document outlines some professional standards and general guidelines to implement across our codebases.

General Guidelines

1. Ensure compatibility with Python version 2.5.2 in all code development.

2. Utilise good Python coding standards and best practices throughout the development process.

Reference Data Guidelines

1. In ICE Workbench, create reference data using uppercase codes.

2. It is preferred to separate words in reference data codes with underscores (e.g., REFERENCE_DATA). However, it is also acceptable to omit underscores if desired (e.g., REFERENCEDATA).

Data Dictionary Guidelines

1. When creating field names in the Data Dictionary, ensure the "Available for MI" option is checked.

2. Follow the proper casing convention for field names, using the format FieldNameHere.

Testing Guidelines

1. Ensure the Testing Harness is utilised and updated at all stages of the development process.

2. It is required that prior to any user testing or deployment, unit tests using the Harness are carried out to cover all potential scenarios. Please provide the results from the unit tests in any Pull Requests.