├── CITATION.cff ├── CODE_OF_CONDUCT.md ├── README.md ├── README.png └── git-commit-template.txt /CITATION.cff: -------------------------------------------------------------------------------- 1 | cff-version: 1.2.0 2 | title: Git commit template 3 | message: >- 4 | If you use this work and you want to cite it, 5 | then you can use the metadata from this file. 6 | type: software 7 | authors: 8 | - given-names: Joel Parker 9 | family-names: Henderson 10 | email: joel@joelparkerhenderson.com 11 | affiliation: joelparkerhenderson.com 12 | orcid: 'https://orcid.org/0009-0000-4681-282X' 13 | identifiers: 14 | - type: url 15 | value: 'https://github.com/joelparkerhenderson/git-commit-template/' 16 | description: Git commit template 17 | repository-code: 'https://github.com/joelparkerhenderson/git-commit-template/' 18 | abstract: >- 19 | Git commit template 20 | license: See license file 21 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | 2 | # Contributor Covenant Code of Conduct 3 | 4 | ## Our Pledge 5 | 6 | We as members, contributors, and leaders pledge to make participation in our 7 | community a harassment-free experience for everyone, regardless of age, body 8 | size, visible or invisible disability, ethnicity, sex characteristics, gender 9 | identity and expression, level of experience, education, socio-economic status, 10 | nationality, personal appearance, race, caste, color, religion, or sexual 11 | identity and orientation. 12 | 13 | We pledge to act and interact in ways that contribute to an open, welcoming, 14 | diverse, inclusive, and healthy community. 15 | 16 | ## Our Standards 17 | 18 | Examples of behavior that contributes to a positive environment for our 19 | community include: 20 | 21 | * Demonstrating empathy and kindness toward other people 22 | * Being respectful of differing opinions, viewpoints, and experiences 23 | * Giving and gracefully accepting constructive feedback 24 | * Accepting responsibility and apologizing to those affected by our mistakes, 25 | and learning from the experience 26 | * Focusing on what is best not just for us as individuals, but for the overall 27 | community 28 | 29 | Examples of unacceptable behavior include: 30 | 31 | * The use of sexualized language or imagery, and sexual attention or advances of 32 | any kind 33 | * Trolling, insulting or derogatory comments, and personal or political attacks 34 | * Public or private harassment 35 | * Publishing others' private information, such as a physical or email address, 36 | without their explicit permission 37 | * Other conduct which could reasonably be considered inappropriate in a 38 | professional setting 39 | 40 | ## Enforcement Responsibilities 41 | 42 | Community leaders are responsible for clarifying and enforcing our standards of 43 | acceptable behavior and will take appropriate and fair corrective action in 44 | response to any behavior that they deem inappropriate, threatening, offensive, 45 | or harmful. 46 | 47 | Community leaders have the right and responsibility to remove, edit, or reject 48 | comments, commits, code, wiki edits, issues, and other contributions that are 49 | not aligned to this Code of Conduct, and will communicate reasons for moderation 50 | decisions when appropriate. 51 | 52 | ## Scope 53 | 54 | This Code of Conduct applies within all community spaces, and also applies when 55 | an individual is officially representing the community in public spaces. 56 | Examples of representing our community include using an official e-mail address, 57 | posting via an official social media account, or acting as an appointed 58 | representative at an online or offline event. 59 | 60 | ## Enforcement 61 | 62 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 63 | reported to the community leaders responsible for enforcement at 64 | [INSERT CONTACT METHOD]. 65 | All complaints will be reviewed and investigated promptly and fairly. 66 | 67 | All community leaders are obligated to respect the privacy and security of the 68 | reporter of any incident. 69 | 70 | ## Enforcement Guidelines 71 | 72 | Community leaders will follow these Community Impact Guidelines in determining 73 | the consequences for any action they deem in violation of this Code of Conduct: 74 | 75 | ### 1. Correction 76 | 77 | **Community Impact**: Use of inappropriate language or other behavior deemed 78 | unprofessional or unwelcome in the community. 79 | 80 | **Consequence**: A private, written warning from community leaders, providing 81 | clarity around the nature of the violation and an explanation of why the 82 | behavior was inappropriate. A public apology may be requested. 83 | 84 | ### 2. Warning 85 | 86 | **Community Impact**: A violation through a single incident or series of 87 | actions. 88 | 89 | **Consequence**: A warning with consequences for continued behavior. No 90 | interaction with the people involved, including unsolicited interaction with 91 | those enforcing the Code of Conduct, for a specified period of time. This 92 | includes avoiding interactions in community spaces as well as external channels 93 | like social media. Violating these terms may lead to a temporary or permanent 94 | ban. 95 | 96 | ### 3. Temporary Ban 97 | 98 | **Community Impact**: A serious violation of community standards, including 99 | sustained inappropriate behavior. 100 | 101 | **Consequence**: A temporary ban from any sort of interaction or public 102 | communication with the community for a specified period of time. No public or 103 | private interaction with the people involved, including unsolicited interaction 104 | with those enforcing the Code of Conduct, is allowed during this period. 105 | Violating these terms may lead to a permanent ban. 106 | 107 | ### 4. Permanent Ban 108 | 109 | **Community Impact**: Demonstrating a pattern of violation of community 110 | standards, including sustained inappropriate behavior, harassment of an 111 | individual, or aggression toward or disparagement of classes of individuals. 112 | 113 | **Consequence**: A permanent ban from any sort of public interaction within the 114 | community. 115 | 116 | ## Attribution 117 | 118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 119 | version 2.1, available at 120 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 121 | 122 | Community Impact Guidelines were inspired by 123 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 124 | 125 | For answers to common questions about this code of conduct, see the FAQ at 126 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at 127 | [https://www.contributor-covenant.org/translations][translations]. 128 | 129 | [homepage]: https://www.contributor-covenant.org 130 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 131 | [Mozilla CoC]: https://github.com/mozilla/diversity 132 | [FAQ]: https://www.contributor-covenant.org/faq 133 | [translations]: https://www.contributor-covenant.org/translations 134 | 135 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Git commit template 2 | 3 | DataGrip + PostgresSQL 4 | 5 | Git commit template to improve your project's commit messages. 6 | 7 | If you want to learn why we use this kind of template, 8 | see our repo [How to write a great git commit message](https://github.com/joelparkerhenderson/git-commit-message). 9 | 10 | If you want to improve your git speed and capabilities, 11 | see our project [GitAlias](https://github.com/gitalias/gitalias). 12 | 13 | The template is below and is also at this link: [git-commit-template.txt](git-commit-template.txt) 14 | 15 | ## Template 16 | 17 | ```sh 18 | ################################################## 19 | # Write a title summarizing what this commit does. 20 | # Start with an uppercase imperative verb, such as 21 | # Add, Drop, Fix, Refactor, Bump; see ideas below. 22 | # Think of your title as akin to an email subject, 23 | # so you don't need to end with a sentence period. 24 | # Use 50 char maximum, which is this line's width. 25 | ################################################## 26 | Add your title here 27 | 28 | ######################################################################## 29 | # Why is this change happening? 30 | # Describe the purpose, such as a goal, or use case, or user story, etc. 31 | # For every line, use 72 char maximum width, which is this line's width. 32 | ######################################################################## 33 | Why: 34 | 35 | ######################################################################## 36 | # How is this change happening? 37 | # Describe any relevant algorithms, protocols, implementation spec, etc. 38 | # For every line, use 72 char maximum width, which is this line's width. 39 | ######################################################################## 40 | How: 41 | 42 | ######################################################################## 43 | # Add any tags you want, such as search text, hashtags, keywords, codes. 44 | # For every line, use 72 char maximum width, which is this line's width. 45 | ######################################################################## 46 | Tags: 47 | 48 | ######################################################################## 49 | # 50 | # ## Help ## 51 | # 52 | # This git commit template is available at: 53 | # https://github.com/joelparkerhenderson/git-commit-template 54 | # 55 | # How to write a good git commit message: 56 | # https://github.com/joelparkerhenderson/git-commit-message 57 | # 58 | # Subject line imperative uppercase verbs: 59 | # 60 | # Add = Create a capability e.g. feature, test, dependency. 61 | # Drop = Delete a capability e.g. feature, test, dependency. 62 | # Fix = Fix an issue e.g. bug, typo, accident, misstatement. 63 | # Bump = Increase the version of something e.g. a dependency. 64 | # Make = Change the build process, or tools, or infrastructure. 65 | # Start = Begin doing something; e.g. enable a toggle, feature flag, etc. 66 | # Stop = End doing something; e.g. disable a toggle, feature flag, etc. 67 | # Optimize = A change that MUST be just about performance, e.g. speed up code. 68 | # Document = A change that MUST be only in the documentation, e.g. help files. 69 | # Refactor = A change that MUST be just refactoring. 70 | # Reformat = A change that MUST be just format, e.g. indent line, trim space, etc. 71 | # Rephrase = A change that MUST be just textual, e.g. edit a comment, doc, etc. 72 | # 73 | # For the subject line: 74 | # 75 | # * Use 50 characters maximum. 76 | # 77 | # * Do not use a sentence-ending period. 78 | # 79 | # For the body text: 80 | # 81 | # * Use as many lines as you like. 82 | # 83 | # * Use 72 characters maximum per line for typical word wrap text. 84 | # 85 | # 86 | # ## Trailers ## 87 | # 88 | # Trailers suitable for tracking and also for `git interpret-trailers`. 89 | # 90 | # Example of "See:" trailers that mean "see this additional information" 91 | # and links to relevant web pages, issue trackers, blog posts, etc.: 92 | # 93 | # See: https://example.com/ 94 | # See: Issue #123 95 | # 96 | # We like to use the "See:" trailers to link to issue trackers (e.g. Jira, 97 | # Asana, Basecamp, Trello), document files and folders (e.g. Box, Dropbox), 98 | # UI/UX designs (e.g. Figma, Lucidchart), reference pages (e.g. Wikipedia, 99 | # internet RFCs, IEEE standards), and web posts (e.g. StackOverflow, HN). 100 | # 101 | # Example of "Co-authored-by:" trailers that list each author's name 102 | # and their preferred commit message email address or contact URL: 103 | # 104 | # Co-authored-by: Alice Adams 105 | # Co-authored-by: Bob Brown 106 | # 107 | # We like to use the "Co-authored-by:" trailers when we pair program, 108 | # triple program, and group program. These are parsed automatically by 109 | # some version control services (e.g. GitHub, GitLab) and will link 110 | # to the authors' accounts and show up on the authors' commit history. 111 | # 112 | # Example of "Sponsored-by:" trailers that list each sponsor's name, 113 | # which could be a person's or organization's, and contact email or URL: 114 | # 115 | # Sponsored-by: Adam Anderson 116 | # Sponsored-by: Bravo Organization 117 | # 118 | # The git tools require trailers to be last in a commit message, 119 | # and must be one trailer per line, and with no extra lines between. 120 | # 121 | # 122 | # ## About ## 123 | # 124 | # This is our team's starting point for our git commit messages. 125 | # You can edit this template as you like, to customize it. 126 | # 127 | # For more information about git commit ideas and help: 128 | # https://github.com/joelparkerhenderson/git-commit-message 129 | # 130 | # 131 | # ## Usage ## 132 | # 133 | # Put the template file here: 134 | # 135 | # ~/.git-commit-template.txt 136 | # 137 | # Configure git to use the template file by running: 138 | # 139 | # git config --global commit.template ~/.git-commit-template.txt 140 | # 141 | # Add the template file to the ~/.gitconfig file: 142 | # 143 | # [commit] 144 | # template = ~/.git-commit-template.txt 145 | # 146 | # If you prefer other file locations or ways of working, 147 | # you can freely adjust the usage as you like. 148 | # 149 | # 150 | # ## Usage needs commit.cleanup strip ## 151 | # 152 | # This template intends for the commit to strip the comments. 153 | # 154 | # To strip the comments, your git `commit.cleanup` config must be `strip`. 155 | # 156 | # If you don't use `strip`, then these commit comments won't be deleted. 157 | # 158 | # 159 | # ## More ideas ## 160 | # 161 | # Some teams like to add a git commit message verification processes, 162 | # such as a git pre-commit hook that runs a linter on the message text. 163 | # 164 | # In our experience, this can be helpful especially if the linter can 165 | # provide advice that explains how to make the message better. 166 | # 167 | # 168 | # ## Tracking ## 169 | # 170 | # * Package: git-commit-template 171 | # * Version: 7.2.0 172 | # * Updated: 2022-11-22T00:55:28Z 173 | # * Licence: GPL-2.0-or-later or contact us for custom license. 174 | # * Contact: Joel Parker Henderson (http://joelparkerhenderson.com) 175 | # 176 | ######################################################################## 177 | 178 | ### GIT TRAILERS -- THESE MUST BE LAST IN THE COMMIT MESSAGE ### 179 | 180 | # Git trailers are optional. Use them if you want, how you want. 181 | # The trailers below are provided as examples that you can customize. 182 | 183 | # For example, you can add any relevant links to a blog post, or graphic 184 | # design images, or industry publications, specifications, tickets, etc. 185 | #See: Description 186 | #See: Description 187 | 188 | # If the commit is written by multiple people, then use the git trailers 189 | # to thank each person as a co-author; various git tools can track this. 190 | #Co-authored-by: Name 191 | #Co-authored-by: Name 192 | 193 | # If the commit is sponsored by a person or company, then add them here. 194 | # This kind of trailer is more-frequent in open source funding projects. 195 | #Sponsored-by: Name 196 | #Sponsored-by: Name 197 | ``` 198 | -------------------------------------------------------------------------------- /README.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/joelparkerhenderson/git-commit-template/3894fd9db1320f8b2553111f5af47b400275daf3/README.png -------------------------------------------------------------------------------- /git-commit-template.txt: -------------------------------------------------------------------------------- 1 | ################################################## 2 | # Write a title summarizing what this commit does. 3 | # Start with an uppercase imperative verb, such as 4 | # Add, Drop, Fix, Refactor, Bump; see ideas below. 5 | # Think of your title as akin to an email subject, 6 | # so you don't need to end with a sentence period. 7 | # Use 50 char maximum, which is this line's width. 8 | ################################################## 9 | Add your title here 10 | 11 | ######################################################################## 12 | # Why is this change happening? 13 | # Describe the purpose, such as a goal, or use case, or user story, etc. 14 | # For every line, use 72 char maximum width, which is this line's width. 15 | ######################################################################## 16 | Why: 17 | 18 | ######################################################################## 19 | # How is this change happening? 20 | # Describe any relevant algorithms, protocols, implementation spec, etc. 21 | # For every line, use 72 char maximum width, which is this line's width. 22 | ######################################################################## 23 | How: 24 | 25 | ######################################################################## 26 | # Add any tags you want, such as search text, hashtags, keywords, codes. 27 | ######################################################################## 28 | Tags: 29 | 30 | ######################################################################## 31 | # 32 | # ## Help ## 33 | # 34 | # This git commit template is available at: 35 | # https://github.com/joelparkerhenderson/git-commit-template 36 | # 37 | # How to write a good git commit message: 38 | # https://github.com/joelparkerhenderson/git-commit-message 39 | # 40 | # Subject line imperative uppercase verbs: 41 | # 42 | # Add = Create a capability e.g. feature, test, dependency. 43 | # Drop = Delete a capability e.g. feature, test, dependency. 44 | # Fix = Fix an issue e.g. bug, typo, accident, misstatement. 45 | # Bump = Increase the version of something e.g. a dependency. 46 | # Make = Change the build process, or tools, or infrastructure. 47 | # Start = Begin doing something; e.g. enable a toggle, feature flag, etc. 48 | # Stop = End doing something; e.g. disable a toggle, feature flag, etc. 49 | # Optimize = A change that MUST be just about performance, e.g. speed up code. 50 | # Document = A change that MUST be only in the documentation, e.g. help files. 51 | # Refactor = A change that MUST be just refactoring. 52 | # Reformat = A change that MUST be just format, e.g. indent line, trim space, etc. 53 | # Rephrase = A change that MUST be just textual, e.g. edit a comment, doc, etc. 54 | # 55 | # For the subject line: 56 | # 57 | # * Use 50 characters maximum. 58 | # 59 | # * Do not use a sentence-ending period. 60 | # 61 | # For the body text: 62 | # 63 | # * Use as many lines as you like. 64 | # 65 | # * Use 72 characters maximum per line for typical word wrap text. 66 | # 67 | # 68 | # ## Trailers ## 69 | # 70 | # Trailers suitable for tracking and also for `git interpret-trailers`. 71 | # 72 | # Example of "See:" trailers that mean "see this additional information" 73 | # and links to relevant web pages, issue trackers, blog posts, etc.: 74 | # 75 | # See: https://example.com/ 76 | # See: Issue #123 77 | # 78 | # We like to use the "See:" trailers to link to issue trackers (e.g. Jira, 79 | # Asana, Basecamp, Trello), document files and folders (e.g. Box, Dropbox), 80 | # UI/UX designs (e.g. Figma, Lucidchart), reference pages (e.g. Wikipedia, 81 | # internet RFCs, IEEE standards), and web posts (e.g. StackOverflow, HN). 82 | # 83 | # Example of "Co-authored-by:" trailers that list each author's name 84 | # and their preferred commit message email address or contact URL: 85 | # 86 | # Co-authored-by: Alice Adams 87 | # Co-authored-by: Bob Brown 88 | # 89 | # We like to use the "Co-authored-by:" trailers when we pair program, 90 | # triple program, and group program. These are parsed automatically by 91 | # some version control services (e.g. GitHub, GitLab) and will link 92 | # to the authors' accounts and show up on the authors' commit history. 93 | # 94 | # Example of "Sponsored-by:" trailers that list each sponsor's name, 95 | # which could be a person's or organization's, and contact email or URL: 96 | # 97 | # Sponsored-by: Adam Anderson 98 | # Sponsored-by: Bravo Organization 99 | # 100 | # The git tools require trailers to be last in a commit message, 101 | # and must be one trailer per line, and with no extra lines between. 102 | # 103 | # 104 | # ## About ## 105 | # 106 | # This is our team's starting point for our git commit messages. 107 | # You can edit this template as you like, to customize it. 108 | # 109 | # For more information about git commit ideas and help: 110 | # https://github.com/joelparkerhenderson/git-commit-message 111 | # 112 | # 113 | # ## Usage ## 114 | # 115 | # Put the template file here: 116 | # 117 | # ~/.git-commit-template.txt 118 | # 119 | # Configure git to use the template file by running: 120 | # 121 | # git config --global commit.template ~/.git-commit-template.txt 122 | # 123 | # Add the template file to the ~/.gitconfig file: 124 | # 125 | # [commit] 126 | # template = ~/.git-commit-template.txt 127 | # 128 | # If you prefer other file locations or ways of working, 129 | # you can freely adjust the usage as you like. 130 | # 131 | # 132 | # ## Usage needs commit.cleanup strip ## 133 | # 134 | # This template intends for the commit to strip the comments. 135 | # 136 | # To strip the comments, your git `commit.cleanup` config must be `strip`. 137 | # 138 | # If you don't use `strip`, then these commit comments won't be deleted. 139 | # 140 | # 141 | # ## More ideas ## 142 | # 143 | # Some teams like to add a git commit message verification processes, 144 | # such as a git pre-commit hook that runs a linter on the message text. 145 | # 146 | # In our experience, this can be helpful especially if the linter can 147 | # provide advice that explains how to make the message better. 148 | # 149 | # 150 | # ## Tracking ## 151 | # 152 | # * Package: git-commit-template 153 | # * Version: 7.2.0 154 | # * Updated: 2022-11-22T00:55:28Z 155 | # * Licence: GPL-2.0-or-later or contact us for custom license. 156 | # * Contact: Joel Parker Henderson (http://joelparkerhenderson.com) 157 | # 158 | ######################################################################## 159 | 160 | ### GIT TRAILERS -- THESE MUST BE LAST IN THE COMMIT MESSAGE ### 161 | 162 | # Git trailers are optional. Use them if you want, how you want. 163 | # The trailers below are provided as examples that you can customize. 164 | 165 | # For example, you can add any relevant links to a blog post, or graphic 166 | # design images, or industry publications, specifications, tickets, etc. 167 | #See: Description 168 | #See: Description 169 | 170 | # If the commit is written by multiple people, then use the git trailers 171 | # to thank each person as a co-author; various git tools can track this. 172 | #Co-authored-by: Name 173 | #Co-authored-by: Name 174 | 175 | # If the commit is sponsored by a person or company, then add them here. 176 | # This kind of trailer is more-frequent in open source funding projects. 177 | #Sponsored-by: Name 178 | #Sponsored-by: Name 179 | --------------------------------------------------------------------------------