ERP5 Guidelines

Guidelines are must read documents which provide directions and principles to guide you in the ERP5 code, documentation, design, etc.

• ERP5 Naming Conventions provides a list of naming conventions which ERP5 developers must follow.

• ERP5 Testing Guidelines defines how developers should test various aspects of ERP5.

• Wiki Authors Guidelines provides advice to authors and contributors of the ERP5 Wiki.

• Documentation Guidelines provides advice to authors of ERP5 related documentation.

• Coding Crimes provides a list of coding styles which are forbidden in ERP5 and the rationale behind.

• Best Coding Practices is a collection of advice in order to improve coding style

• Best Commit Practices is a collection of advices in order to improve usability of ERP5 code repository

• URL Generation specifies how URLs should be generated.

• Performance Crimes provides a list of code behaviours which cost to performance and the correct behaviour.

• I18n specifies where translation should happen.

• Naming Crimes provides a list of bad namings.

• CommonPitfalls provides hints about why your code doesn't work as you expect.

Some guidelines are under discussion:

• User Interface Guidelines

• Business Template Configuration Guidelines

• Discussion/GuidelinesForFieldLibrary Guidelines for Field library

• XHTML and CSS Guidelines