Skip to content

Commit da73b1f

Browse files
committed
feat(copilot): add commit message style guide
- Introduced a new markdown file for commit message guidelines. - Ensures adherence to the Conventional Commits format. - Aims to improve clarity and consistency in commit messages across the project.
1 parent 189c82b commit da73b1f

2 files changed

Lines changed: 24 additions & 39 deletions

File tree

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Commit Message Style Guide
2+
3+
Follow the Conventional Commits format strictly for commit messages. Use the structure below:
4+
5+
```
6+
<type>[optional scope]: <description>
7+
8+
[optional body]
9+
```
10+
11+
## Guidelines
12+
13+
1. **Type and Scope**: Choose an appropriate type (e.g., `feat`, `fix`) and optional scope to describe the affected module or feature.
14+
2. **Description**: Write a concise, informative description in the header; use backticks if referencing code or specific terms.
15+
3. **Body**: For additional details, use a well-structured body section:
16+
- Use bullet points (`*`) for clarity.
17+
- Clearly describe the motivation, context, or technical details behind the change, if applicable.
18+
19+
Commit messages should be clear, informative, and professional, aiding readability and project tracking.

.vscode/settings.json

Lines changed: 5 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,10 @@
11
{
2-
"fileGenerator.configs": [
2+
"github.copilot.chat.commitMessageGeneration.instructions": [
33
{
4-
"tasks": [
5-
// ! Test current file (node)
6-
{
7-
"terminalInstanceType": "label",
8-
"runTaskOnFileCreation": false,
9-
"label": "Test current file (node)",
10-
"command": "npm test",
11-
"args": ["${relativeTargetFile}"]
12-
},
13-
{
14-
"runTaskOnFileCreation": true,
15-
"label": "Watch current file (node)",
16-
"command": "npm test",
17-
"userInputPrompt": [
18-
[
19-
{
20-
"label": "--coverage"
21-
}
22-
]
23-
],
24-
"args": ["--watch", "${relativeTargetFile}"]
25-
},
26-
{
27-
"terminalInstanceType": "label",
28-
"runTaskOnFileCreation": false,
29-
"label": "Test directory (node)",
30-
"command": "npm test",
31-
"shouldSwitchToFile": false,
32-
"args": ["${relativeFileDirname}"]
33-
}
34-
],
35-
"label": "Tests",
36-
"fileSuffixType": "extend extension",
37-
"filesSuffix": "test",
38-
"directoryName": "tests",
39-
"supportedExtension": ["ts", "tsx", "js", "jsx"],
40-
"defaultLocationForFiles": "project root",
41-
"description": "Tests Creator"
4+
"file": ".github/copilot/commit-message-style.md"
5+
},
6+
{
7+
"file": "commitlint.config.mjs"
428
}
439
]
4410
}

0 commit comments

Comments
 (0)