Most Powerful Open Source ERP

ERP5 Guideline Coding Best Practice

A list of rules and patterns to adhere to in order to write clean, maintainable and accessible code including coding crimes to avoid.
  • Last Update:2017-04-05
  • Version:001
  • Language:en

Table of Contents

Introduction

These guidelines have been written to ensure all code written is clean, maintainable and accessible code ensureing that code is resuable and can be understood in the future by anyone having to work on it.

While this often means additional effort in the short term, the long term benefits of a large maintainable codebase by far outweigh the time put in when writing new code.

The following rules crimes and guidelines apply to all programming languages used (the guidelines combine JavaScript rules and Python best practice and coding crimes).