Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 370168 - visual polish for git commit page
Summary: visual polish for git commit page
Status: RESOLVED FIXED
Alias: None
Product: Orion
Classification: ECD
Component: Git (show other bugs)
Version: 0.4   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 0.4 RC2   Edit
Assignee: Szymon Brandys CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 371264 (view as bug list)
Depends on:
Blocks:
 
Reported: 2012-01-30 16:23 EST by Susan McCourt CLA
Modified: 2012-02-16 06:35 EST (History)
3 users (show)

See Also:
malgorzata.tomczyk: review+


Attachments
screenshot and ideas (50.53 KB, image/png)
2012-01-30 16:23 EST, Susan McCourt CLA
no flags Details
Changes on the commit page (screenshot1) (19.08 KB, image/png)
2012-02-01 07:49 EST, Szymon Brandys CLA
no flags Details
Changes on the commit page (screenshot2) (22.14 KB, image/png)
2012-02-01 07:49 EST, Szymon Brandys CLA
no flags Details
Changes on the commit page (screenshot3) (19.97 KB, image/png)
2012-02-01 07:50 EST, Szymon Brandys CLA
no flags Details
screenshot (72.60 KB, image/png)
2012-02-03 03:14 EST, Susan McCourt CLA
no flags Details
the correct screenshot (33.19 KB, image/png)
2012-02-03 03:15 EST, Susan McCourt CLA
no flags Details
Fix v1 (4.04 KB, patch)
2012-02-16 05:24 EST, Szymon Brandys CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Susan McCourt CLA 2012-01-30 16:23:33 EST
Created attachment 210285 [details]
screenshot and ideas

In bug 369683, Linda provided a mockup of the repositories page.
https://bugs.eclipse.org/bugs/attachment.cgi?id=210234
This bug covers doing similar polish in the git commit page.

Some specific things to note:

- move model icon for commits and tags into the heading rather than next to the items, since the info repeats
- header styling, fonts, etc. per mockup (should be doable in the settings.css)

and then specific to the commit page (see screenshot):

- commit description font is too big, can we move the description to the top of the rendering and keep same font?  Giving it its own line will make it important/stand out
- pic of author is fun but not the most important thing.  move to the right by the author/commit info
Comment 1 John Arthorne CLA 2012-01-31 13:44:46 EST
(In reply to comment #0)
> - commit description font is too big, can we move the description to the top of
> the rendering and keep same font?  Giving it its own line will make it
> important/stand out

Putting the commit description at the top makes sense. It is the most important information I think.

> - pic of author is fun but not the most important thing.  move to the right by
> the author/commit info

Can try it but the icon on the left seems very natural. For example twitter, facebook, and github all put the author icon on the left. Now that I'm used to the thumbnails of the various committers I find it easier to pick out a face from a list than scan for names when I'm looking for someone's changes.

https://github.com/eclipse/orion.client/commits/master
Comment 2 Szymon Brandys CLA 2012-01-31 15:22:49 EST
(In reply to comment #0)
> - commit description font is too big, can we move the description to the top of
> the rendering and keep same font?  Giving it its own line will make it
> important/stand out

I was looking at commit pages at git.eclipse.org e.g. 

http://git.eclipse.org/c/orion/org.eclipse.orion.client.git/commit/?id=6522bd4db1547f53f7ae226dee3ad0f679034451

The title is under the hash and author, committer details there. Moreover the commit message may be multiline, in this case it is better to show it under other details which are always one line. See for instance how git.eclipse.org renders this:

http://git.eclipse.org/c/orion/org.eclipse.orion.client.git/commit/?id=7cdb1df648acc943ad9dcce2cc04e41de6c03a9f

I do it the same way on our commit page.

> - pic of author is fun but not the most important thing.  move to the right by
> the author/commit info

I agree with John about the current position of the author icon.
Comment 3 John Arthorne CLA 2012-01-31 15:38:13 EST
Hm, that's a good point, some projects have conventions where the commit comment can be paragraphs in length. A common convention is the first 80 chars of the comment is a summary, so one option is we put a short summary at the top but if the comment is longer make remaining lines smaller. E.g.,

https://github.com/eclipse/orion.client/commit/a82f626fd29cd7252aea95e6a61ac0f7371ab0af
Comment 4 John Arthorne CLA 2012-01-31 15:47:47 EST
I've seen various git commit message guidelines, and they vary between 50-70 characters for the first line. Here is one that gets referenced alot (many copies of it floating around):

https://github.com/git/git/blob/master/Documentation/SubmittingPatches
Comment 5 Susan McCourt CLA 2012-01-31 21:32:42 EST
(In reply to comment #2)
> (In reply to comment #0)
> > - commit description font is too big, can we move the description to the top of
> > the rendering and keep same font?  Giving it its own line will make it
> > important/stand out
> 
> I was looking at commit pages at git.eclipse.org e.g. 
> 
> http://git.eclipse.org/c/orion/org.eclipse.orion.client.git/commit/?id=6522bd4db1547f53f7ae226dee3ad0f679034451

I have the same problem with this that I do our page.  You have to scan through a bunch of small print to get to the part you care about.  The fact that something in bold/big print is way down the description is a clue to me that it's a bit unorganized.  So I like the idea of rendering the first line/first n characters.
Comment 6 Szymon Brandys CLA 2012-02-01 07:49:12 EST
Created attachment 210366 [details]
Changes on the commit page (screenshot1)
Comment 7 Szymon Brandys CLA 2012-02-01 07:49:57 EST
Created attachment 210367 [details]
Changes on the commit page (screenshot2)
Comment 8 Szymon Brandys CLA 2012-02-01 07:50:38 EST
Created attachment 210368 [details]
Changes on the commit page (screenshot3)
Comment 9 Susan McCourt CLA 2012-02-03 03:14:03 EST
Created attachment 210493 [details]
screenshot

I know we can't make every commit look good, but here's an example that looks particularly funny.  
- it gets truncated, ok, I can deal with that
- but it also wraps.  (insult to injury...truncation AND wrapping?)
- hard to parse the ellipsis.  Maybe we should do the ellipsis at a word break for better readability.

We should widen the title area as wide as the commit diffs??
Increase the truncation point?
break at a word if possible?
Comment 10 Susan McCourt CLA 2012-02-03 03:15:32 EST
Created attachment 210494 [details]
the correct screenshot

sigh, second time in as many days I attach an old screenshot.
Comment 11 Szymon Brandys CLA 2012-02-03 05:07:05 EST
Breaking at a word makes sense. I'll play with it.
Comment 12 Szymon Brandys CLA 2012-02-10 12:48:41 EST
*** Bug 371264 has been marked as a duplicate of this bug. ***
Comment 13 Szymon Brandys CLA 2012-02-16 05:24:44 EST
Created attachment 211092 [details]
Fix v1
Comment 14 Malgorzata Janczarska CLA 2012-02-16 06:05:00 EST
(In reply to comment #13)
> Created attachment 211092 [details]
> Fix v1

This patch changes the way commit name is divided into two lines and rendered. It looks much better now.