Welcome!

The CHANGELOG should be created for every Odoo module repository. Each repository can hold multiple modules, it is important that we can track the changes for each module, so when we deploy a new release with multiple changes across multiple modules we can be certain what has changed.

When to update this file:

Update this file on the first commit when working on a new ticket or are of change if a ticket covers multiple features.

Add the message to the work in progress section under the module name.

If you are adding a new module, just add a new line in the Work in progress section with a description of what the module does.

if you are removing a module, write a description of why it was removed.

How to make a new release:

When releasing a new module change 'Work in progress' to the new version name and tag in git. Create a new section for 'Work in progress' with an empty list of the modules.

The following is an example file:

Work in progress

module1 [1.1]

module2 [1.2]

 - REMOVED - reason for removal

module3 [1.0]

- ticket title/description or change description

1.4 - released dd/mm/yyyy

module1 [1.1]

- ticket title/description or change description

module2 [1.2]

module3 [1.0]

- description of what the module does

1.3 - released dd/mm/yyyy

module1 [1.0]

module2 [1.2]

- ticket title/description or change description

1.1 - released dd/mm/yyyy

module1 [1.0]

module2 [1.1]

- ticket title/description or change description

1.0 - released dd/mm/yyyy

module1 [1.0]

  - description of what the module does  

module2 [1.0]

  - description of what the module does