kf-component-library 4.0.0 → 4.0.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/README.md +44 -29
- package/dist/main.cjs.js +32 -199
- package/dist/main.es.js +9423 -9200
- package/package.json +21 -21
package/README.md
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
# kf-component-library
|
|
2
2
|
|
|
3
|
-
A modern, accessible, and customizable React component library built with [Radix UI](https://www.radix-ui.com/), [Tailwind CSS](https://tailwindcss.com/), and [Vite](https://vitejs.dev/).
|
|
4
|
-
Perfect for building beautiful, production-ready UIs with speed and consistency.
|
|
3
|
+
A modern, accessible, and customizable React component library built with [Radix UI](https://www.radix-ui.com/), [Tailwind CSS](https://tailwindcss.com/), and [Vite](https://vitejs.dev/). Perfect for building beautiful, production-ready UIs with speed and consistency.
|
|
5
4
|
|
|
6
5
|
## Features
|
|
7
6
|
|
|
@@ -80,53 +79,69 @@ This project follows a **feature branch workflow** with automated releases using
|
|
|
80
79
|
|
|
81
80
|
### Development Workflow
|
|
82
81
|
|
|
82
|
+
1. Start from develop
|
|
83
|
+
|
|
83
84
|
```bash
|
|
84
|
-
# 1. Start from develop branch
|
|
85
85
|
git checkout develop
|
|
86
86
|
git pull origin develop
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
2. Create a branch
|
|
87
90
|
|
|
88
|
-
|
|
91
|
+
```bash
|
|
89
92
|
git checkout -b feature/new-component
|
|
90
93
|
# or: git checkout -b fix/button-styling
|
|
91
|
-
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
3. Implement changes and push
|
|
92
97
|
|
|
93
|
-
|
|
94
|
-
#
|
|
98
|
+
```bash
|
|
99
|
+
# edit files...
|
|
95
100
|
git add .
|
|
96
|
-
git commit -m "
|
|
101
|
+
git commit -m "Implement feature"
|
|
102
|
+
git push -u origin HEAD
|
|
103
|
+
```
|
|
97
104
|
|
|
98
|
-
|
|
99
|
-
git push origin feature/new-component
|
|
105
|
+
Open a PR: feature/fix → develop. Merge after review.
|
|
100
106
|
|
|
101
|
-
|
|
102
|
-
# 6. Review and merge to develop
|
|
107
|
+
Lockfile policy:
|
|
103
108
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
git pull origin develop # Pull the merged changes
|
|
107
|
-
# Now ready for next feature branch
|
|
108
|
-
```
|
|
109
|
+
- Lockfile conflicts are avoided via `.gitattributes` (`pnpm-lock.yaml merge=ours`) which keeps `develop`’s lockfile.
|
|
110
|
+
- If your change updates `package.json`, do not hand-merge the lockfile in the PR; let `develop` win and regenerate on `develop` later.
|
|
109
111
|
|
|
110
|
-
|
|
112
|
+
4. Prepare release on develop (after features are merged)
|
|
111
113
|
|
|
112
114
|
```bash
|
|
113
|
-
# 1. Create changeset (on develop branch)
|
|
114
115
|
git checkout develop
|
|
116
|
+
git pull origin develop
|
|
117
|
+
|
|
118
|
+
# Bump versions with Changesets
|
|
115
119
|
pnpm changeset
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
# Write description of changes
|
|
120
|
+
pnpm changeset version
|
|
121
|
+
```
|
|
119
122
|
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
123
|
+
5. Regenerate lockfile deterministically
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
rm -f pnpm-lock.yaml
|
|
127
|
+
pnpm install --lockfile-only --ignore-scripts
|
|
124
128
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
129
|
+
git add .changeset/ package.json pnpm-lock.yaml
|
|
130
|
+
git commit -m "chore: version and lockfile"
|
|
131
|
+
git push origin develop
|
|
128
132
|
```
|
|
129
133
|
|
|
134
|
+
6. Release PR: develop → main
|
|
135
|
+
|
|
136
|
+
- Open PR from `develop` into `main`.
|
|
137
|
+
- If `package.json` conflicts, keep `develop` (it already contains the version bumped above).
|
|
138
|
+
- Merge to `main` to release.
|
|
139
|
+
|
|
140
|
+
Notes:
|
|
141
|
+
|
|
142
|
+
- `package.json` has a `packageManager` field. Run `corepack enable` locally to use the pinned pnpm version.
|
|
143
|
+
- Prefer regenerating the lockfile over manual conflict resolution.
|
|
144
|
+
|
|
130
145
|
### Branch Strategy
|
|
131
146
|
|
|
132
147
|
- **`main`** - Production releases, triggers automatic npm publishing
|