Most Powerful Open Source ERP

Developer Documentation

Guideline Live Tests Should Not Be Run On Production

Create and remove data is dangerous in production.

Guideline Logs Must Contain Their Cause

Test report must contain info on the cause of a log

Guideline Commits Are Atomic

Changes from a motivation must be committed together.

Guideline Read Patch Before Commit

Read your patch before committing.

Guideline Log Clear Enough To Disable Easily

It should be easy to track logs in the code.

Guideline Fix Whitespace In A Separate Commit

It is a motivation to fix unneeded whitespace.

Guideline Commits Are Purpose Based

A change in code must have a motivation (like fixing a bug).

Guideline Test Changes Before Committing

Verify that system is usable after your change.

Guideline End A File With Empty Line

Some tools cannot handle, display file as truncated.

Guideline Never Commit Debugger Code

No pdb-related code (import, call to set_trace, ...).

Guideline Modify Correct Changelog On Business Template Commits

Differentiate major changes and purpose changelog.

Guideline Use Log Levels

Log levels help understand the importance of a log.

Guideline Create Resonable Log Messages

The code will be read in many contexts.

Guideline Never Log Level Info Or More In Execution Path

Avoid trivial logs.

How To Use Git Client in ERP5

How To showing usage of the integrated git client in ERP5 to work with code.

How To Use Commit From ERP5

Document showing how to work with business templates using git from inside ERP5.

Guideline Never Create Interdependent Test Methods

It makes finding broken tests much harder.