-
Notifications
You must be signed in to change notification settings - Fork 0
/
.git_commit_template.txt
49 lines (39 loc) · 1.53 KB
/
.git_commit_template.txt
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
# Git Commit Message Template
#<type>(<scope>): <subject>
# - <scope>: Optional. Describes the module, component, or section of the project affected by the commit.
# Example:
# feat(users): add user authentication
# - Implement user authentication using OAuth 2.0.
# - Introduce new routes for user login and registration.
# Best Practices:
# - Use a clear and concise language.
# - Separate the subject from the body with a blank line.
# - Separate the body from the footer with a blank line.
# - Keep the subject line limited to 50 characters.
# - Use the imperative mood in the subject (e.g., "Fix" instead of "Fixed").
# - Provide context and details in the body.
# - Reference issues or related information in the footer.
# Commit Types:
# - feat: A new feature for the user or a significant change.
# - fix: A bug fix.
# - chore: Routine tasks, maintenance, or tooling changes.
# - docs: Documentation changes.
# - style: Code style changes (e.g., formatting).
# - refactor: Code refactorings without adding new features or fixing bugs.
# - test: Adding or modifying tests.
# - build: Changes related to the build system or external dependencies.
# - ci: Changes to the continuous integration (CI) configuration or scripts.
# - perf: Performance improvements.
# - revert: Reverting a previous commit.
#The keywords that can use to automatically close an issue from a commit message are:
# - close
# - closes
# - closed
# - fix
# - fixes
# - fixed
# - resolve
# - resolves
# - resolved
# Example:
# git commit -m "Your commit message here. Resolves #456."