No longer mention issue and PR numbers in commit title

[nipafx]

The current contribution guidelines define the following outline for commit messages, where the first line (let's call it "title") has an ideal length of 50 characters, with a maximum of 70:

${action} (${issues} / ${pull-request})

${body}

Mentioning issue and pull request numbers in the title has the advantage of making them very visible, for example in git log --oneline and GitHub's UI, but has the downside of severely reducing the number of available characters for the title itself. Once we cross into three digit issue/PR numbers (#abc / #xyz) eats up at least 14 characters - that's not good.

As an alternative, issues and pull requests could be added as a last line to the message:

${action}

${body}

${issues} / ${pull-request}

Opinions?

[sormuras]

70? 2 8 0 !

Your proposal looks good to me.

[sbrannen]

I agree, but let's also use prefixes for the issue and PR numbers -- for example:

${action}

${body}

Issue: ${issues} / ${pull-request}

Where "Issue" can be:

• Issue
• Issues
• Fixes
• Closes

[nipafx]

@sbrannen Are the replacements for "Issue" meant to be GitHub keywords? If so, we have to get rid of the colon, don't we?

[nipafx]

I just looked over the list of commits and I have to say, I really like what I see: the issue and PR numbers out in the open. Are we sure we want to give that up?

Since I seem to be the only one thinking "No" and ... team ... democracy ... yadda yadda yadda 😉 ... check #86.

[sbrannen]

Are the replacements for "Issue" meant to be GitHub keywords?

Jein ("yes & no" for non-German speakers). 😉

It's a mix. See explanation here: #86 (comment)

If so, we have to get rid of the colon, don't we?

Nope. GitHub has no problem with the colon.