pp-dev-js/.gitmessage at main · mi-examples/pp-dev-js · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# <type>(<scope>): <subject>
#
# <body>
#
# <footer>
#
# COMMIT TYPES (choose one):
#   feat     A new feature (triggers MINOR version bump)
#   fix      A bug fix (triggers PATCH version bump)
#   docs     Documentation only changes (NO version bump)
#   style    Code style changes, formatting, etc (NO version bump)
#   refactor Code refactoring, no functional changes (NO version bump)
#   perf     Performance improvements (NO version bump)
#   test     Adding or updating tests (NO version bump)
#   chore    Maintenance tasks, dependencies, etc (NO version bump)
#   ci       CI/CD configuration changes (NO version bump)
#   build    Build system or external dependency changes (NO version bump)
#
# SCOPES (optional, but recommended):
#   pp-dev           Changes to the pp-dev package
#   create-pp-dev    Changes to the create-pp-dev package
#   api              API-related changes
#   auth             Authentication/authorization changes
#   ui               User interface changes
#   build            Build system changes
#   ci               CI/CD changes
#   deps             Dependency updates
#   docs             Documentation changes
#   test             Testing changes
#   utils            Utility functions
#   config           Configuration changes
#
# SUBJECT:
#   - Use imperative mood ("add" not "added")
#   - Don't capitalize first letter
#   - No period at the end
#   - Keep it concise (50 chars or less)
#
# BODY:
#   - Explain WHAT and WHY, not HOW
#   - Use imperative mood
#   - Wrap at 72 characters
#
# FOOTER:
#   - Breaking changes: "BREAKING CHANGE: <description>"
#
# EXAMPLES:
#   feat(pp-dev): add new authentication middleware
#   fix(api): resolve memory leak in data processing
#   docs(readme): update installation instructions
#   style: format code according to prettier rules
#   refactor(utils): extract common validation functions
#   perf(render): optimize image loading performance
#   test(e2e): add comprehensive login test suite
#   chore(deps): update all dependencies to latest versions
#   ci(github): add semantic-release workflow
#   build(rollup): optimize bundle size
#
# BREAKING CHANGES:
#   feat(api): change response format structure
#
#   BREAKING CHANGE: API now returns data in different structure.
#   All existing clients must be updated to handle new format.
#

#
# TIPS:
#   - Only feat, fix, and BREAKING CHANGE trigger version bumps
#   - Use scopes to indicate which package/area is affected
#   - Be descriptive but concise