Commit messages and CRLF

General discussion of development ideas and the approaches taken in the 3.x branch of phpBB. The current feature release of phpBB 3 is 3.3/Proteus.
Forum rules
Please do not post support questions regarding installing, updating, or upgrading phpBB 3.3.x. If you need support for phpBB 3.3.x please visit the 3.3.x Support Forum on phpbb.com.

If you have questions regarding writing extensions please post in Extension Writers Discussion to receive proper guidance from our staff and community.
Post Reply
User avatar
Louis7777
Registered User
Posts: 394
Joined: Fri Apr 04, 2014 12:32 am

Commit messages and CRLF

Post by Louis7777 »

A commit message looks like this (https://wiki.phpbb.com/Git):

Code: Select all

[branch you are working on] A short explanation of the change.

A more detailed explanation of which things exactly were changed and for
what reasons.

This can span multiple paragraphs for a bigger change. And
it should really make clear all the changes to anyone reading this commit
message without further context.

TICKET-ID
A commit message shouldn't contain any CRLF characters. Lines should end with LF.

While that is not a problem when I'm using my properly configured git client for Windows, I cannot figure out how to avoid it on the Github website.

It is convenient for me to create pull requests by visiting Github and clicking on the green button for "New pull request". But when I type my commit message I have no control over carriage returns, or do I?

Is it a protocol thing to always add CRLF by the end of a line? Or can I somehow configure my browser to use LF?

User avatar
callumacrae
Former Team Member
Posts: 1046
Joined: Tue Apr 27, 2010 9:37 am
Location: England
Contact:

Re: Commit messages and CRLF

Post by callumacrae »

I'm pretty sure nobody has ever checked commit messages for the correct line endings
Made by developers, for developers!
My blog

Nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 299
Joined: Sun Apr 13, 2014 1:40 am
Location: Paris

Re: Commit messages and CRLF

Post by Nicofuma »

Actually it is done by the commit inspector IIRC. And for the OP, sorry I don't think it is possible.
Member of the phpBB Development-Team
No Support via PM

User avatar
Louis7777
Registered User
Posts: 394
Joined: Fri Apr 04, 2014 12:32 am

Re: Commit messages and CRLF

Post by Louis7777 »

Nicofuma wrote:Actually it is done by the commit inspector IIRC. And for the OP, sorry I don't think it is possible.
So I assume that no one in the development team uses Github's web interface for creating pull requests - I'll have to stick with the git client, right?

Nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 299
Joined: Sun Apr 13, 2014 1:40 am
Location: Paris

Re: Commit messages and CRLF

Post by Nicofuma »

To edit the files and commit the changes? I guess yes
Member of the phpBB Development-Team
No Support via PM

User avatar
callumacrae
Former Team Member
Posts: 1046
Joined: Tue Apr 27, 2010 9:37 am
Location: England
Contact:

Re: Commit messages and CRLF

Post by callumacrae »

Louis7777 wrote:
Nicofuma wrote:Actually it is done by the commit inspector IIRC. And for the OP, sorry I don't think it is possible.
So I assume that no one in the development team uses Github's web interface for creating pull requests - I'll have to stick with the git client, right?
Check out hub to create pull requests from the command line :)
Made by developers, for developers!
My blog

User avatar
nickvergessen
Former Team Member
Posts: 733
Joined: Sun Oct 07, 2007 11:54 am
Location: Stuttgart, Germany
Contact:

Re: Commit messages and CRLF

Post by nickvergessen »

I create the PRs always via GitHubs website and I'm also in windows.

As long as the commit messages themselves are fine, nothing breaks from it.
Member of the Development-TeamNo Support via PM

User avatar
Louis7777
Registered User
Posts: 394
Joined: Fri Apr 04, 2014 12:32 am

Re: Commit messages and CRLF

Post by Louis7777 »

nickvergessen wrote:I create the PRs always via GitHubs website and I'm also in windows.
What browser are you using?

So when you type your commit message over at GitHub and you press enter to leave a blank line, don't you cause any CRLF? :o

Post Reply