[TYPO3-team-core-v5] Changelog considerations

[Bastian Waidelich]

Robert Lemke wrote:

Hi Robert,

> Taking Masi's advice, let's change them to:
> 
> FEATURE
> FIX
> API
> CONFIGURATION
> TASK
> !!!

sounds good!
Some questions though:

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?

What if I'm committing a feature that adds a method to the API?
"[+API][+FEATURE] FLOW3 (Core): Method initializeDrupal() has been added 
to the Bootsrap"
Or would I still have to write two lines?

When changing something that is not related to a sub package (e.g. 
global configuration) I'd leave out the  "(SubPackage)"-part, right?

Should we make the -~+ prefixes mandatory? After all every commit adds, 
removes or changes something ;)

"FIX" could be "BUGFIX", no? According to dict.cc "fix" means something 
like "pointer" or "clue" rather than error-correcting.


>> And we might even enforce them by a simple pre-commit hook.
>> What do you think?
> 
> Well, why not - can you do that?

I've written a little script that checks each line of the commit message 
against the following regular expression:
^(?P<BreakingChange>\[!!!\])?\[(?P<Prefix>[\+\-\~])?(?P<Type>FEATURE|FIX|API|CONFIGURATION|TASK)\]\s(?P<Package>[A-Z][A-Za-z0-9]+)(\s\((?P<SubPackage>[A-Z][A-Za-z0-9]+)\))?:\s(?P<Message>.*)$

and intercepts the commit if one or more lines are incorrect.

I'll talk to one of the admins about how to activate this as pre-commit 
only for specified folders of the repository.

Maybe we should allow an additional type [NOTE] to be able to circumvent 
the check then.


> Yes, I'd be very happy if you or someone else could write a little php
> script doing that conversion. Just a standalone script - I'll integrate
> that later into a whole-in-one release app.

I'll write a little package if you don't mind - I need some practice ;)
You'll have it before the next release!

Bastian