Most Powerful Open Source ERP

Developer Documentation

16- 04 2024

Guideline Never Log Level Info Or More In Execution Path

Avoid trivial logs.
Categories crime ; commit ; debug ; test ; log
16- 04 2024

Guideline Never Create Interdependent Test Methods

It makes finding broken tests much harder.
Categories crime ; commit ; test
01- 12 2021

How To Use Commit From ERP5

Document showing how to work with business templates using git from inside ERP5.
Categories commit ; git ; business template
23- 10 2019

Guideline Live Tests Should Not Be Run On Production

Create and remove data is dangerous in production.
Categories rule ; commit ; test
15- 07 2019

Guideline Logs Must Contain Their Cause

Test report must contain info on the cause of a log
Categories rule ; commit ; debug ; test ; log
15- 07 2019

Guideline Commits Are Atomic

Changes from a motivation must be committed together.
Categories rule ; commit
15- 07 2019

Guideline Read Patch Before Commit

Read your patch before committing.
Categories recommendation ; commit
15- 07 2019

Guideline Log Clear Enough To Disable Easily

It should be easy to track logs in the code.
Categories rule ; commit ; debug ; log
15- 07 2019

Guideline Fix Whitespace In A Separate Commit

It is a motivation to fix unneeded whitespace.
Categories rule ; commit
15- 07 2019

Guideline Commits Are Purpose Based

A change in code must have a motivation (like fixing a bug).
Categories rule ; commit
15- 07 2019

Guideline Test Changes Before Committing

Verify that system is usable after your change.
Categories rule ; commit ; test
15- 07 2019

Guideline End A File With Empty Line

Some tools cannot handle, display file as truncated.
Categories rule ; commit
15- 07 2019

Guideline Never Commit Debugger Code

No pdb-related code (import, call to set_trace, ...).
Categories crime ; commit ; debug
15- 07 2019

Guideline Modify Correct Changelog On Business Template Commits

Differentiate major changes and purpose changelog.
Categories rule ; commit ; business template
15- 07 2019

Guideline Use Log Levels

Log levels help understand the importance of a log.
Categories rule ; commit ; debug ; test ; log
15- 07 2019

Guideline Create Resonable Log Messages

The code will be read in many contexts.
Categories commit ; recommendation ; debug ; log
18- 09 2018

How To Use Git Client in ERP5

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