@clubmatto/ai-kit 0.0.8 → 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/src/commands/commit.md +42 -14
package/README.md
CHANGED
|
@@ -87,7 +87,7 @@ git add ai-kit/package.json
|
|
|
87
87
|
git commit -m "release: bump version to <version>"
|
|
88
88
|
|
|
89
89
|
# Create git tag and push both (tag triggers automated release)
|
|
90
|
-
git tag ai-kit/v<version>
|
|
90
|
+
git tag -a ai-kit/v<version> -m "v<version>"
|
|
91
91
|
git push origin main --follow-tags
|
|
92
92
|
```
|
|
93
93
|
|
package/package.json
CHANGED
package/src/commands/commit.md
CHANGED
|
@@ -8,8 +8,21 @@ Create a commit with the following format:
|
|
|
8
8
|
|
|
9
9
|
**First line (one-liner):**
|
|
10
10
|
|
|
11
|
-
- Use conventional commits format: `<type
|
|
12
|
-
-
|
|
11
|
+
- Use conventional commits format: `<type>(<scope>): <description>`
|
|
12
|
+
- The **scope** is the project subdirectory — determine it from the changed files.
|
|
13
|
+
|
|
14
|
+
| Changed files | Scope |
|
|
15
|
+
|---------------------------|--------------|
|
|
16
|
+
| `fakedata/**` | `fakedata` |
|
|
17
|
+
| `ai-kit/**` | `ai-kit` |
|
|
18
|
+
| Mixed (multiple projects) | Pick primary |
|
|
19
|
+
|
|
20
|
+
- If changes span **multiple projects**, pick the one with the most changes, or use
|
|
21
|
+
`type: description` (without scope) when there is no clear primary project.
|
|
22
|
+
- Root-level files (e.g. `opencode.json`, `.github/`, `AGENTS.md`) and changes
|
|
23
|
+
spanning **all** projects get no scope.
|
|
24
|
+
- Examples: `feat(fakedata): add csv output`, `fix(ai-kit): resolve sync crash`,
|
|
25
|
+
`docs: update contributing guide`
|
|
13
26
|
|
|
14
27
|
**Body (bullet list):**
|
|
15
28
|
|
|
@@ -19,26 +32,41 @@ Create a commit with the following format:
|
|
|
19
32
|
**Sign-off:**
|
|
20
33
|
|
|
21
34
|
- End with: `created with the help of <MODEL>`
|
|
22
|
-
-
|
|
35
|
+
- Format the model name as lowercase, hyphenated: `<name>-<variant>`
|
|
36
|
+
- Examples: `DeepSeek V4 Flash` → `deepseek-v4-flash`, `Claude Opus 4` → `claude-opus-4`
|
|
37
|
+
|
|
38
|
+
## Examples
|
|
39
|
+
|
|
40
|
+
**Single project — use scope:**
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
feat(fakedata): add csv output format
|
|
44
|
+
|
|
45
|
+
- Added --format csv flag to generate command
|
|
46
|
+
- Implemented CSV writer with header detection
|
|
47
|
+
- Added tests for CSV output
|
|
48
|
+
|
|
49
|
+
created with the help of deepseek-v4-flash
|
|
50
|
+
```
|
|
23
51
|
|
|
24
|
-
|
|
52
|
+
**Cross-project or root — no scope:**
|
|
25
53
|
|
|
26
54
|
```
|
|
27
|
-
|
|
55
|
+
ci: add shared release workflow for Go projects
|
|
28
56
|
|
|
29
|
-
- Created
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
- Added --skip-opencode option
|
|
57
|
+
- Created tools/go-release with build, archive, and formula generation
|
|
58
|
+
- Updated fakedata release workflow to use shared tool
|
|
59
|
+
- Added release documentation
|
|
33
60
|
|
|
34
|
-
created with the help of
|
|
61
|
+
created with the help of deepseek-v4-flash
|
|
35
62
|
```
|
|
36
63
|
|
|
37
64
|
## Process
|
|
38
65
|
|
|
39
66
|
1. First, review all changes with `git status` and `git diff`
|
|
40
67
|
2. If there changes you did not make, ask if you should include them
|
|
41
|
-
3.
|
|
42
|
-
4.
|
|
43
|
-
5.
|
|
44
|
-
6.
|
|
68
|
+
3. Determine the scope from the changed file paths
|
|
69
|
+
4. Write a concise one-liner following `<type>(<scope>): <description>`
|
|
70
|
+
5. List the key changes as bullet points
|
|
71
|
+
6. Add the sign-off line with the current model
|
|
72
|
+
7. Commit with `git commit -m "your message"`
|