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

Add commit message template TIL #33

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add commit message template TIL #33

wants to merge 4 commits into from

Conversation

BenGitsCode
Copy link
Owner

@BenGitsCode BenGitsCode commented Oct 27, 2017

  • Commit message template

-  Just a placeholder title for now, so I remember to come back to this and
write it out when I have the time.
- I love them.
- I've left this branch ignored for waaay too long. Time to finish it up and
make a PR.
- These are two of my favorite little git tricks too.
- Adds instructions for setting up a template, as well as an example of the one
I use most.
- Git is a proper noun.
@BenGitsCode BenGitsCode changed the title Add two git TILs Add commit message template TIL Oct 27, 2017
@laurpaik-zz laurpaik-zz self-requested a review November 3, 2017 15:49
@laurpaik-zz laurpaik-zz self-assigned this Nov 3, 2017
#
```

What many people don't realize, is that you can actually customize that message. Doing so allows you to not only have a nice guide for your
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that comma is misplaced, but I don't know where it's supposed to go, so I'm improvising a suggestion:

- What many people don't realize, is that you can actually customize that message.
+ You can actually customize that message!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just want to clarify-- that default message is supposed to show up every time, correct? I followed your instructions -- my commit message shows up before the default, but it doesn't replace the default like I originally thought.


1. Some visual of the line length so I don't go over (plenty of text editor plugins that will do this just as well...or better)
1. A reminder to use imperative language in the subject line.
1. A couple questions that get me thinking not just about what the change is and not even just why make the change? These questions help me
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence doesn't make sense 😱 Is this what you meant?

- A couple questions that get me thinking not just about what the change is and not even just why make the change?
+ A couple questions that get me thinking not just about _what_ the change is, but also _why_ make the change?

1. Some visual of the line length so I don't go over (plenty of text editor plugins that will do this just as well...or better)
1. A reminder to use imperative language in the subject line.
1. A couple questions that get me thinking not just about what the change is and not even just why make the change? These questions help me
get at the _most important concept_ behind a commit. Yes, why did you make the change, but also _for what purpose / towards what objective_.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite follow the difference between "why did you make the change" and "for what purpose towards what objective." If that's what you meant, could I get an example?
My instinct tells me "Yes, what change did you make, but also for what purpose / towards what objective." but that's just because I don't see the difference between 'why' and 'for what purpose'

1. A couple questions that get me thinking not just about what the change is and not even just why make the change? These questions help me
get at the _most important concept_ behind a commit. Yes, why did you make the change, but also _for what purpose / towards what objective_.
1. A nice glossary of leading active verbs for the subject line. I often find myself gazing down there and rewriting my subject line in
accordance with one of these. I don't always follow those leading active verbs militantly--but my commits are always better when I do.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redundant

- I don't always follow those leading active verbs militantly--but my commits are always better when I do.
+ I don't follow those leading active verbs militantly, but my commits are always better when I do.

or

- I don't always follow those leading active verbs militantly--but my commits are always better when I do.
+ I don't always follow those suggestions, but my commits are always better when I do.

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

Successfully merging this pull request may close these issues.

2 participants