commit message reminder (72-80)

[smichr]

Just a reminder that commit messages will look best when viewed in a command window (e.g. git bash) when the title is not longer than 72 characters, is followed by a blank line, and successive lines are not longer than 80 characters. (If the title is not longer than 72 characters, then the entire title will show up in the git log --oneline view which puts the title in line with the shortened SHA1 of the branch.)

/chris

[Mateusz Paprocki]

Hi,

On 29 June 2012 19:29, smichr <smi...@gmail.com> wrote:

Just a reminder that commit messages will look best when viewed in a command window (e.g. git bash) when the title is not longer than 72 characters, is followed by a blank line, and successive lines are not longer than 80 characters. (If the title is not longer than 72 characters, then the entire title will show up in the git log --oneline view which puts the title in line with the shortened SHA1 of the branch.)

If we are at this, I would also like to point out that commit messages shouldn't be manually indented (see e.g. 27a6e3356b316e9c98166dfb6811d82f2ed4b887).

 

/chris

--
You received this message because you are subscribed to the Google Groups "sympy" group.
To view this discussion on the web visit https://groups.google.com/d/msg/sympy/-/tmPTNAZ1OggJ.
To post to this group, send email to sy...@googlegroups.com.
To unsubscribe from this group, send email to sympy+un...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/sympy?hl=en.

Mateusz

[Ondřej Čertík]

On Fri, Jun 29, 2012 at 12:56 PM, Mateusz Paprocki <mat...@gmail.com> wrote:
> Hi,
>
> On 29 June 2012 19:29, smichr <smi...@gmail.com> wrote:
>>
>> Just a reminder that commit messages will look best when viewed in a
>> command window (e.g. git bash) when the title is not longer than 72
>> characters, is followed by a blank line, and successive lines are not longer
>> than 80 characters. (If the title is not longer than 72 characters, then the
>> entire title will show up in the git log --oneline view which puts the title
>> in line with the shortened SHA1 of the branch.)

+1

>
>
> If we are at this, I would also like to point out that commit messages
> shouldn't be manually indented (see
> e.g. 27a6e3356b316e9c98166dfb6811d82f2ed4b887).

+1

The commit is:

commit 27a6e3356b316e9c98166dfb6811d82f2ed4b887
Author: Aleksandar Makelov <>
Date: Tue Jun 26 15:30:59 2012 +0300

Removed isinstance and duplicate code from orbit()

At the suggestion of Stefan Krastanov.

so there should not be the whitespace on the left. Github seems to strip it:

https://github.com/sympy/sympy/commit/27a6e3356b316e9c98166dfb6811d82f2ed4b887

But it shouldn't be there anyway.

Ondrej

[Chris Smith]

I wonder if the commit message(s) can be tested by the bot.

/c

[Chris Smith]

I see that github now gives the commit message along with the commit.
This is nice, but it appears to use its own markup which means that
maybe we should include such markup (which is pretty non-intrusive,
anyway) in the commit message. Note, for example, in
https://github.com/sympy/sympy/pull/1375 that my indented message (not
title as was referred to by Mateusz) appears as quoted text.

/c

[Aaron Meurer]

It should use the same markup as pull request comments. It's just
markdown. So you can use

Headers
=======

And markup code like

```py
>>> 1+1
2
```

It will look good in plaintext and in GitHub.

Aaron Meurer

> --
> You received this message because you are subscribed to the Google Groups "sympy" group.