Skip to content

Instantly share code, notes, and snippets.

@js1darren

js1darren/.git-commit-template

Forked from zakkak/.git-commit-template
Created July 30, 2023 04:12
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save js1darren/4289ae79e3cf93849a103b6948519fc2 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save js1darren/4289ae79e3cf93849a103b6948519fc2 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @zakkak zakkak revised this gist Jul 14, 2017. 2 changed files with 38 additions and 30 deletions.
    38 changes: 38 additions & 0 deletions .git-commit-template
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,38 @@
    # [<tag>] (If applied, this commit will...) <subject> (Max 72 char)
    # |<---- Preferably using up to 50 chars --->|<------------------->|
    # Example:
    # [feat] Implement automated commit messages

    # (Optional) Explain why this change is being made
    # |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|

    # (Optional) Provide links or keys to any relevant tickets, articles or other resources
    # Example: Github issue #23

    # --- COMMIT END ---
    # Tag can be
    # feat (new feature)
    # fix (bug fix)
    # refactor (refactoring code)
    # style (formatting, missing semi colons, etc; no code change)
    # doc (changes to documentation)
    # test (adding or refactoring tests; no production code change)
    # version (version bump/new release; no production code change)
    # jsrXXX (Patches related to the implementation of jsrXXX, where XXX the JSR number)
    # jdkX (Patches related to supporting jdkX as the host VM, where X the JDK version)
    # dbg (Changes in debugging code/frameworks; no production code change)
    # license (Edits regarding licensing; no production code change)
    # hack (Temporary fix to make things move forward; please avoid it)
    # WIP (Work In Progress; for intermediate commits to keep patches reasonably sized)
    # defaults (changes default options)
    #
    # Note: Multiple tags can be combined, e.g. [fix][jsr292] Fix issue X with methodhandles
    # --------------------
    # Remember to:
    # * Capitalize the subject line
    # * Use the imperative mood in the subject line
    # * Do not end the subject line with a period
    # * Separate subject from body with a blank line
    # * Use the body to explain what and why vs. how
    # * Can use multiple lines with "-" or "*" for bullet points in body
    # --------------------
    30 changes: 0 additions & 30 deletions .git-commit-template.txt
    View file
    Original file line number Diff line number Diff line change
    @@ -1,30 +0,0 @@
    # <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

    # --- COMMIT END ---
    # Type can be
    # feat (new feature)
    # fix (bug fix)
    # refactor (refactoring production code)
    # style (formatting, missing semi colons, etc; no code change)
    # docs (changes to documentation)
    # test (adding or refactoring tests; no production code change)
    # chore (updating grunt tasks etc; no production code change)
    # --------------------
    # Remember to
    # Capitalize the subject line
    # Use the imperative mood in the subject line
    # Do not end the subject line with a period
    # Separate subject from body with a blank line
    # Use the body to explain what and why vs. how
    # Can use multiple lines with "-" for bullet points in body
    # --------------------
    # For more information about this template, check out
    # https://gist.github.com/adeekshith/cd4c95a064977cdc6c50
  2. @adeekshith adeekshith revised this gist Jun 17, 2016. No changes.
  3. @adeekshith adeekshith revised this gist Mar 14, 2016. No changes.
  4. @adeekshith adeekshith revised this gist Mar 13, 2016. 1 changed file with 8 additions and 10 deletions.
    18 changes: 8 additions & 10 deletions .git-commit-template.txt
    View file
    Original file line number Diff line number Diff line change
    @@ -10,21 +10,19 @@

    # --- COMMIT END ---
    # Type can be
    # feat (new feature)
    # fix (bug fix)
    # docs (changes to documentation)
    # style (formatting, missing semi colons, etc; no code change)
    # feat (new feature)
    # fix (bug fix)
    # refactor (refactoring production code)
    # test (adding missing tests, refactoring tests; no production code change)
    # chore (updating grunt tasks etc; no production code change)
    # style (formatting, missing semi colons, etc; no code change)
    # docs (changes to documentation)
    # test (adding or refactoring tests; no production code change)
    # chore (updating grunt tasks etc; no production code change)
    # --------------------
    # Remember to
    # Separate subject from body with a blank line
    # Limit the subject line to 50 characters
    # Capitalize the subject line
    # Do not end the subject line with a period
    # Use the imperative mood in the subject line
    # Wrap the body at 72 characters
    # Do not end the subject line with a period
    # Separate subject from body with a blank line
    # Use the body to explain what and why vs. how
    # Can use multiple lines with "-" for bullet points in body
    # --------------------
  5. @adeekshith adeekshith revised this gist Mar 4, 2016. 1 changed file with 4 additions and 2 deletions.
    6 changes: 4 additions & 2 deletions .git-commit-template.txt
    View file
    Original file line number Diff line number Diff line change
    @@ -1,7 +1,9 @@
    # <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
    @@ -26,5 +28,5 @@
    # Use the body to explain what and why vs. how
    # Can use multiple lines with "-" for bullet points in body
    # --------------------
    # For a full example of how to write a good commit message, check out
    # https://github.com/sparkbox/how_to/tree/master/style/git
    # For more information about this template, check out
    # https://gist.github.com/adeekshith/cd4c95a064977cdc6c50
  6. @adeekshith adeekshith revised this gist Mar 2, 2016. No changes.
  7. @adeekshith adeekshith revised this gist Mar 2, 2016. No changes.
  8. @adeekshith adeekshith revised this gist Feb 29, 2016. 1 changed file with 25 additions and 22 deletions.
    47 changes: 25 additions & 22 deletions .git-commit-template.txt
    View file
    Original file line number Diff line number Diff line change
    @@ -1,27 +1,30 @@
    # Type(<scope>): <subject>
    # <type>: (If applied, this commit will...) <subject> (Max 50 char)

    # <body>

    # <footer>
    # Explain why this change is being made

    # Type should be one of the following:
    # * feat (new feature)
    # * fix (bug fix)
    # * docs (changes to documentation)
    # * style (formatting, missing semi colons, etc; no code change)
    # * refactor (refactoring production code)
    # * test (adding missing tests, refactoring tests; no production code change)
    # * chore (updating grunt tasks etc; no production code change)
    # Scope is just the scope of the change. Something like (admin) or (teacher).
    # Subject should use impertivite tone and say what you did.
    # The body should go into detail about changes made.
    # The footer should contain any JIRA (or other tool) issue references or actions.
    # Provide links or keys to any relevant tickets, articles or other resources
    # Example: Github issue #23

    # --- COMMIT END ---
    # Type can be
    # feat (new feature)
    # fix (bug fix)
    # docs (changes to documentation)
    # style (formatting, missing semi colons, etc; no code change)
    # refactor (refactoring production code)
    # test (adding missing tests, refactoring tests; no production code change)
    # chore (updating grunt tasks etc; no production code change)
    # --------------------
    # Remember to
    # Separate subject from body with a blank line
    # Limit the subject line to 50 characters
    # Capitalize the subject line
    # Do not end the subject line with a period
    # Use the imperative mood in the subject line
    # Wrap the body at 72 characters
    # Use the body to explain what and why vs. how
    # Can use multiple lines with "-" for bullet points in body
    # --------------------
    # For a full example of how to write a good commit message, check out
    # https://github.com/sparkbox/how_to/tree/master/style/git

    # ---------------------------------------------------------------------------------
    # Jira Issue Processing
    # ISSUE_KEY #comment This is a comment
    # ISSUE_KEY #done
    # ---------------------------------------------------------------------------------
    # https://github.com/sparkbox/how_to/tree/master/style/git
  9. @Linell Linell revised this gist Jun 2, 2015. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions .git-commit-template.txt
    View file
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,7 @@
    # Type(<scope>): <subject>

    # <body>

    # <footer>

    # Type should be one of the following:
  10. @Linell Linell created this gist Feb 12, 2015.
    25 changes: 25 additions & 0 deletions .git-commit-template.txt
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,25 @@
    # Type(<scope>): <subject>
    # <body>
    # <footer>

    # Type should be one of the following:
    # * feat (new feature)
    # * fix (bug fix)
    # * docs (changes to documentation)
    # * style (formatting, missing semi colons, etc; no code change)
    # * refactor (refactoring production code)
    # * test (adding missing tests, refactoring tests; no production code change)
    # * chore (updating grunt tasks etc; no production code change)
    # Scope is just the scope of the change. Something like (admin) or (teacher).
    # Subject should use impertivite tone and say what you did.
    # The body should go into detail about changes made.
    # The footer should contain any JIRA (or other tool) issue references or actions.

    # For a full example of how to write a good commit message, check out
    # https://github.com/sparkbox/how_to/tree/master/style/git

    # ---------------------------------------------------------------------------------
    # Jira Issue Processing
    # ISSUE_KEY #comment This is a comment
    # ISSUE_KEY #done
    # ---------------------------------------------------------------------------------