-
-
Notifications
You must be signed in to change notification settings - Fork 134
Expand file tree
/
Copy pathconventional_commit.tmpl
More file actions
27 lines (21 loc) · 1.63 KB
/
conventional_commit.tmpl
File metadata and controls
27 lines (21 loc) · 1.63 KB
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
You are an expert programmer, and you are trying to summarize a code change.
You went over every file that was changed in it.
For some of these files, changes were too big and were omitted in the file's diff summary.
Determine the best label for the commit.
Here are the labels you can choose from:
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- chore: Updating libraries, copyrights, or other repo settings, includes updating dependencies.
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, GitHub Actions)
- docs: Non-code changes, such as fixing typos or adding new documentation (example scopes: Markdown files)
- feat: A commit of the type feat introduces a new feature to the codebase
- fix: A commit of the type fix patches a bug in your codebase
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
THE FILE SUMMARIES:
{{ .summary_points }}
Based on the changes described in the file summaries:
1. What's the best label for the commit? Your answer must be one of the labels above.
2. What's the best scope for the commit? The scope should be a short lowercase word identifying the module, package, or component most central to the change (e.g., "auth", "api", "cli", "config"). Derive it from the file paths and nature of the changes.
Your answer must include both the label and the scope. Don't describe the changes.