|
| 1 | +type(scope): subject |
| 2 | + |
| 3 | +# Body |
| 4 | + |
| 5 | +# Footer |
| 6 | + |
| 7 | + |
| 8 | +## Types: |
| 9 | +# feat: A new feature |
| 10 | +# fix: A bug fix |
| 11 | +# docs: Documentation only changes |
| 12 | +# lint: Changes that do not affect the meaning of the code (white-space, |
| 13 | +# formatting, missing semicolons, etc) |
| 14 | +# refactor: A code change that neither fixes a bug or adds a feature |
| 15 | +# test: Adding missing tests or correcting existing tests |
| 16 | +# chore: Changes to the build process or auxiliary tools and libraries such as |
| 17 | +# distribution generation |
| 18 | + |
| 19 | +## Scope |
| 20 | +# The scope could be anything specifying place of the commit change. |
| 21 | +# For example `notification', 'dropdown', etc. The scope must be written in |
| 22 | +# kebab-case. |
| 23 | + |
| 24 | +## Subject |
| 25 | +# A brief but meaningfull description of the change. Here are some |
| 26 | +# recommandation for writing your subject: |
| 27 | +# - use the imperative, present tense: "change" not "changed" nor "changes" |
| 28 | +# - don't capitalize first letter |
| 29 | +# - no "." (dot) at the end |
| 30 | + |
| 31 | +## Body |
| 32 | +# The body should include the motivation for the change and contrast this with |
| 33 | +# previous behavior. |
| 34 | +# It is optional but highly recommended for any impacting changes. |
| 35 | + |
| 36 | +## Footer |
| 37 | +# The footer should contain any information about Breaking Changes and is also |
| 38 | +# the place to reference JIRA ticket related to this commit. |
| 39 | +# The footer is optional but for feat and fix type the JIRA reference is |
| 40 | +# mandatory. |
| 41 | +# The breaking changes must be at the end of the commit with only "BROKEN:" |
| 42 | +# before the list of breaking changes. They must be each on a new line. |
| 43 | + |
| 44 | +## Example |
| 45 | +# feat(toto-service): provide toto for all |
| 46 | +# |
| 47 | +# Before we had to do another thing. There was this and this problem. |
| 48 | +# Now, by using "toto", it's simpler and the problems are managed. |
| 49 | +# |
| 50 | +# LUM-3462 |
| 51 | +# BROKEN: |
| 52 | +# first thing broken |
| 53 | +# second thing broken |
0 commit comments