ai-project-boilerplate 1.3.0 → 1.3.1
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/package.json
CHANGED
|
@@ -14,35 +14,16 @@
|
|
|
14
14
|
- `feature/<short-description>` — for new functionality
|
|
15
15
|
- `fix/<short-description>` — for bug fixes
|
|
16
16
|
### PR Flow
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
# 2. Implement, commit changes, then push
|
|
22
|
-
git push -u origin feature/<short-description>
|
|
23
|
-
|
|
24
|
-
# 3. Create PR
|
|
25
|
-
gh pr create --title "<title>" --body "$(cat <<'EOF'
|
|
26
|
-
## Summary
|
|
27
|
-
- <bullet points>
|
|
28
|
-
|
|
29
|
-
## Test plan
|
|
30
|
-
- [ ] <manual test steps>
|
|
31
|
-
EOF
|
|
32
|
-
)"
|
|
33
|
-
|
|
34
|
-
# 4. Check CI status
|
|
35
|
-
gh pr checks
|
|
36
|
-
|
|
37
|
-
# 5. Merge and delete branch after approval
|
|
38
|
-
gh pr merge --squash --delete-branch
|
|
39
|
-
```
|
|
17
|
+
1. Create a feature or fix branch and push to remote
|
|
18
|
+
2. Open a pull request targeting `main` (e.g. via `gh pr create` or your Git host's UI)
|
|
19
|
+
3. Check CI status (e.g. `gh pr checks`)
|
|
20
|
+
4. Merge and delete the branch after approval (e.g. `gh pr merge --squash --delete-branch`)
|
|
40
21
|
|
|
41
22
|
### Release Flow
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
23
|
+
1. Bump the version (follow your project's versioning convention)
|
|
24
|
+
2. Commit the version change and tag the commit (e.g. `vX.Y.Z`)
|
|
25
|
+
3. Push the tag to remote
|
|
26
|
+
4. Publish / deploy (e.g. create a release on your Git host, publish to a registry, deploy to an environment)
|
|
46
27
|
|
|
47
28
|
## Key Conventions
|
|
48
29
|
<!-- Naming, file organization, patterns to follow -->
|