Files

802 B

Creating good commit messages

  1. Use the following format:
<type>: <subject>

<body>

The valid values are: fix, feat, chore, docs Type and subject are required Body is optional

  1. If there is a body, separate it from the subject with a blank line

  2. Limit the subject line to 50 characters. This is not a hard limit but a rule of thumb. The subject line should explain the "what" of the logical change

  3. Capitalize the subject line

  4. Do not end the subject line with a period

  5. Use the imperative mood in the subject line Imperative mood just means “spoken or written as if giving a command or instruction”. A few examples:

    • Clean your room
    • Close the door
    • Take out the trash
  6. Wrap the body at 72 characters

  7. Use the body to explain what and why vs. how