[TYPO3-team-core-v5] Changelog considerations

Karsten Dambekalns karsten at typo3.org
Tue Jul 7 12:51:39 CEST 2009


Hi Robert.

On 06.07.2009 16:54 Uhr, Robert Lemke wrote:
>> The difference between [~API] and [~TASK] is, that in the second case
>> I'm changing something that is not code related or is not part of the
>> public API (marked @internal). Correct?
>
> Could be code related but usually is something not worth mentioning in
> the release notes. API changes always must be tagged with [~API].

*Public* API changes must be tagged API.

> I tended to use FLOW3 (Core) for something FLOW3 distribution related but
> that might be misleading.

Yep, rather use "[TASK] FLOW3 distribution: Changed foo to bar"

>> Should we make the -~+ prefixes mandatory? After all every commit adds,
>> removes or changes something ;)
>
> Well, I guess [TASK] doesn't need it at least.

Making them mandatory would be a very easy and consistent rule...

>> "FIX" could be "BUGFIX", no? According to dict.cc "fix" means something
>> like "pointer" or "clue" rather than error-correcting.
>
> Okay. Additionally we could agree on:
>
> [+BUGFIX] This commit really resolves the bug and closes the ticket
> [~BUGFIX] Changed / added some code related to a bug fix, maybe even
> after it has been closed.
> [-BUGFIX] Reverted the bugfix - need to re-open the ticket

Added those to the documentation.

Regards,
Karsten


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