Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Option to show commit descriptions #11

Closed
jiku opened this issue Sep 2, 2016 · 5 comments
Closed

Option to show commit descriptions #11

jiku opened this issue Sep 2, 2016 · 5 comments

Comments

@jiku
Copy link

jiku commented Sep 2, 2016

For when someone commits with a "WIP" message, just to add an essay description.

@paulirish
Copy link
Owner

good idea, but i'm not sure if the format parameter can support that https://git-scm.com/docs/git-log

@jiku
Copy link
Author

jiku commented Sep 4, 2016

Something like

...
%(color:black) %(color:reset)|%(contents:subject)
%(color:black) %(color:reset)|%(contents:body)%0a"

works, but seems hard to conditionally add extra newlines and stuff to make it more readable. (git log - Is it possible to dynamically generate git log format? - Stack Overflow)

@paulirish
Copy link
Owner

Hmm this isn't what I expected.

This would help in the case that the commit message said "WIP" but then they left a longform commit description right under that? That seems unlikely.

@jiku
Copy link
Author

jiku commented Sep 7, 2016

Yeah. Maybe not as brief as "WIP", but something like git commit -m "Changes to folds. WIP." -m "Explains why, what's left to do, adds references, etc.". Done from tools having a message char limit (warning), encouraging use of description. I do that on experimental branches, and it's often unclear even to future me what's going on until I see the description, in spite of the combination of branch name, changes and commit messages like the above.

Maybe most don't (need to) clarify stuff with descriptions, or do it with code annotations or files/tools (MD's, imdone and the like), with the intent of removing any fluff when squashing upstream. So I'll just close and use a fork. Thanks. :)

@jiku jiku closed this as completed Sep 7, 2016
@paulirish
Copy link
Owner

alright man. sounds good. Thanks for explaining!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants