To avoid OpenFisca users being surprised by the unexpected renaming of a variable that breaks their code, we use standard commit messages when renaming a variable. The syntax is formalised below. It must be respected precisely, to allow automatic information extraction.
Renaming one or several variables will be notified by a commit message that utilises one independent line per renamed variable with the following syntax:
Rename former_name to new_name
No other information must appear on this line.
Introducing one or several new variables will be notified by a commit message that utilises, one separate line per created variable with the following syntax:
Introduce new_name
No other information must appear on this line.
If a variable must not be used anymore, it will be notified by a commit message that utilises one separate line per deprecated variable with the following syntax:
Deprecate former_name
No other information must appear on this line.