kf-component-library 1.4.7 → 1.5.0
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 +62 -5
- package/dist/main.cjs.js +47 -47
- package/dist/main.es.js +2815 -2783
- package/package.json +23 -25
package/README.md
CHANGED
|
@@ -15,10 +15,6 @@ Perfect for building beautiful, production-ready UIs with speed and consistency.
|
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
17
|
pnpm add kf-component-library
|
|
18
|
-
# or
|
|
19
|
-
npm install kf-component-library
|
|
20
|
-
# or
|
|
21
|
-
yarn add kf-component-library
|
|
22
18
|
```
|
|
23
19
|
|
|
24
20
|
## Usage
|
|
@@ -76,7 +72,68 @@ You can override styles using the `className` prop or extend Tailwind's config.
|
|
|
76
72
|
### Requirements
|
|
77
73
|
|
|
78
74
|
- Node.js 18+
|
|
79
|
-
- pnpm
|
|
75
|
+
- pnpm
|
|
76
|
+
|
|
77
|
+
## Daily Development
|
|
78
|
+
|
|
79
|
+
This project follows a **feature branch workflow** with automated releases using [Changesets](https://github.com/changesets/changesets).
|
|
80
|
+
|
|
81
|
+
### Development Workflow
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# 1. Start from develop branch
|
|
85
|
+
git checkout develop
|
|
86
|
+
git pull origin develop
|
|
87
|
+
|
|
88
|
+
# 2. Create feature branch
|
|
89
|
+
git checkout -b feature/new-component
|
|
90
|
+
# or: git checkout -b fix/button-styling
|
|
91
|
+
# or: git checkout -b docs/update-readme
|
|
92
|
+
|
|
93
|
+
# 3. Make your changes
|
|
94
|
+
# ... edit files ...
|
|
95
|
+
git add .
|
|
96
|
+
git commit -m "Add new component"
|
|
97
|
+
|
|
98
|
+
# 4. Push feature branch
|
|
99
|
+
git push origin feature/new-component
|
|
100
|
+
|
|
101
|
+
# 5. Create PR: feature/new-component → develop
|
|
102
|
+
# 6. Review and merge to develop
|
|
103
|
+
|
|
104
|
+
# 7. Update local develop branch
|
|
105
|
+
git checkout develop
|
|
106
|
+
git pull origin develop # Pull the merged changes
|
|
107
|
+
# Now ready for next feature branch
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Release Process
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
# 1. Create changeset (on develop branch)
|
|
114
|
+
git checkout develop
|
|
115
|
+
pnpm changeset
|
|
116
|
+
# Select packages that changed
|
|
117
|
+
# Choose version bump (patch/minor/major)
|
|
118
|
+
# Write description of changes
|
|
119
|
+
|
|
120
|
+
# 2. Commit changeset
|
|
121
|
+
git add .changeset/
|
|
122
|
+
git commit -m "Add changeset for new component"
|
|
123
|
+
git push origin develop
|
|
124
|
+
|
|
125
|
+
# 3. Create release PR: develop → main
|
|
126
|
+
# 4. Review and approve PR
|
|
127
|
+
# 5. Merge PR → automatic release! 🚀
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Branch Strategy
|
|
131
|
+
|
|
132
|
+
- **`main`** - Production releases, triggers automatic npm publishing
|
|
133
|
+
- **`develop`** - Integration branch for features
|
|
134
|
+
- **`feature/*`** - Feature development branches
|
|
135
|
+
- **`fix/*`** - Bug fix branches
|
|
136
|
+
- **`docs/*`** - Documentation update branches
|
|
80
137
|
|
|
81
138
|
## Contributing
|
|
82
139
|
|