Last active
September 19, 2024 14:13
-
-
Save Linell/bd8100c4e04348c7966d to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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 | |
| # --------------------------------------------------------------------------------- |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
It's been a long time since I made this but the only thing I've changed functionally is that I no longer bother with the
(<scope>)portion because, if you're writing decent messages, that should be pretty obvious from your message as a whole and that helps ensure you're able to write a good subject line without using too many characters.It's also worth noting that, while the template specifically mentions JIRA, Github issues work exactly the same way. You can do it via something as simple as:
to close issue number 1001.