a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto
bluesky
typescript
npm
chore: document commit workflow
+25
+25
CLAUDE.md
+25
CLAUDE.md
···
57
57
it does error, prefer finding a solution that satisfies the type system naturally before resorting
58
58
to an assertion
59
59
60
+
### commit workflow
61
+
62
+
we use conventional commits with these rules:
63
+
64
+
- accepted types: `feat`, `fix`, `refactor`, `docs`, `chore`
65
+
- optional scope is the package name, e.g. `refactor(package-a):`
66
+
- omit the scope when the change does not involve any specific package, or when it touches most/all
67
+
packages
68
+
- never list multiple packages in the scope (e.g. `refactor(package-a,package-b)` is forbidden)
69
+
- append `!` after the type/scope to mark breaking changes, e.g. `feat(package-a)!:` or `refactor!:`
70
+
71
+
scope selection when multiple packages are involved:
72
+
73
+
- if the change primarily involves `package-a` over `package-b`, pick `package-a`
74
+
- if changes in `package-a` and `package-b` hinge on `package-c` (even if `package-c` itself was not
75
+
modified), pick `package-c`
76
+
77
+
granularity — each commit should represent one logical change:
78
+
79
+
- split distinct changes into separate commits rather than bundling them
80
+
- pair each changeset with the single commit it describes, so the changeset's git hash maps to the
81
+
right change; do not write one changeset covering multiple commits
82
+
- pair each README update with the commit it documents, rather than batching doc updates across
83
+
multiple changes
84
+
60
85
### documentation
61
86
62
87
- documentations include README, code comments, commit messages