Search code examples
githubgit-commitgithub-for-mac

What is the difference between summary and description in GitHub Desktop?


Though I don't find it annoying or anything like that but I just wanted to know how is specifying either of the summary or description different while making a commit using the desktop version on GitHub? How do I provide these two together on terminal using git commit ?


Solution

  • The summary is the first line of a commit message: it summarizes the reason for the commit (why, not what)
    See "The Art of the Commit"

    The rest goes into the description.

    enter image description here


    By convention, that first line is not supposed to be more than 50 characters:
    See this template

    # <type>: (If applied, this commit will...) <subject> (Max 50 char)
    # |<----  Using a Maximum Of 50 Characters  ---->|
    
    
    # Explain why this change is being made
    # |<----   Try To Limit Each Line to a Maximum Of 72 Characters   ---->|
    
    # Provide links or keys to any relevant tickets, articles or other resources
    # Example: Github issue #23
    

    Other Git GUIs do enfornce the same summary/description convention, like Atomio:

    https://cdn-images-1.medium.com/max/1200/1*dSJ0TgQUPX2ukRwgZi9RBQ.gif