[TYPO3-team-core-v5] Changelog considerations

Bastian Waidelich bastian at typo3.org
Thu Jul 2 11:12:03 CEST 2009


Bastian Waidelich wrote:

hello again,

> ~ = No API change

Karsten just enlightened me:
"~" does not stand for "no change" but rather for "changed, as opposed 
to added or removed - e.g. a method signature has changed"

so lets try again:

+ = API extended (e.g. new method added, new class added)
- = API reduced (e.g. method removed, class removed)
~ = API changed (e.g. method argument added, method return type changed, 
property changed)

we definitely need to write those down ;)

An other thing I forgot:
Obviously a change can be a feature (or bugfix or config/api change) 
_and_ a breaking change at the same time.
The current way to report this, is to add two lines:
[!!!] feature foo breaks bar
[FEAT] feature foo

But we've just discussed that and I think we should link those issues 
better.
[!!!][FEAT] feature foo breaks bar
or
[!FEAT] feature foo breaks bar
or [!!!FEAT], [FEAT!!!]...

Bastian


More information about the TYPO3-team-core-v5 mailing list