On 07/02/2017 15:03, David Sommerseth wrote:
> On 07/02/17 11:09, Samuli Seppänen wrote:
>> Actually, that was just the line length for _code_, not for commit
>> messages. So the only indirect guideline for Git commit message line
>> length was
>
> Correct.
>
>> "The maximum length of the line differs between projects, it's usually
>> somewhere between 50 and 78 characters"
>>
>> which was on this page:
>>
>> <http://who-t.blogspot.fi/2009/12/on-commit-messages.html>
>>
>> The "seven rules" URL David linked to says the following:
>>
>> * Limit the subject line to 50 characters
>> * Wrap the body at 72 characters
>>
>> I can't recall us ever agreeing to such limits.
>
> That is actually a pretty much a de-facto standard among all git users.
> The subject line at 50 chars is because it makes git shortlog, git log
> --oneline and similar tools produce reasonable outputs which keeps the
> total line length, including indenting, within 78 characters.
>
> In addition github, gitlab, gerrit, etc will also truncate subject lines
> which are longer than 50 characters.
>
> Similarly the body wrapping at 72, is to account for a similar indenting
> which git does when presenting the body message text.
>
> And it just takes a quick look at our git log to see that we try to stay
> beyond that limit.  We do sometimes exceed 50 characters, and we let
> that pass silently.  But more than 3 times longer, then something must
> be done.
>
>

I rewrote the DevelopDocumentation page:

<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentationNew>

Changes in a nutshell:

- Most of the verbose but useful stuff was moved to separate page
- Some totally outdated content was removed (FRP, release process, etc)
- Redundant content was removed

Does the new page look like a reasonable starting point for _new_ 
developers?

-- 
Samuli Seppänen
Community Manager
OpenVPN Technologies, Inc

irc freenode net: mattock

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel

Reply via email to