@cryterion/expo-chat-ui 1.0.2 → 1.1.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.
Files changed (2) hide show
  1. package/README.md +67 -0
  2. package/package.json +7 -2
package/README.md CHANGED
@@ -133,6 +133,73 @@ interface ChatTheme {
133
133
  }
134
134
  ```
135
135
 
136
+ ## Contributing
137
+
138
+ We welcome contributions! This project uses [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning and releases.
139
+
140
+ ### Commit Message Format
141
+
142
+ All commits must follow the conventional commit format:
143
+
144
+ ```
145
+ <type>(<scope>): <description>
146
+
147
+ [optional body]
148
+
149
+ [optional footer(s)]
150
+ ```
151
+
152
+ **Types:**
153
+ - `feat:` - A new feature (triggers minor version bump)
154
+ - `fix:` - A bug fix (triggers patch version bump)
155
+ - `docs:` - Documentation changes only
156
+ - `style:` - Code style changes (formatting, missing semicolons, etc.)
157
+ - `refactor:` - Code changes that neither fix bugs nor add features
158
+ - `perf:` - Performance improvements
159
+ - `test:` - Adding or updating tests
160
+ - `chore:` - Maintenance tasks, dependency updates, etc.
161
+
162
+ **Breaking Changes:**
163
+ - Add `!` after the type/scope (e.g., `feat!:`) or
164
+ - Include `BREAKING CHANGE:` in the footer
165
+
166
+ This triggers a major version bump.
167
+
168
+ **Examples:**
169
+ ```bash
170
+ feat: add message reactions
171
+ fix(input): disable autocorrect on iOS
172
+ feat(theme)!: replace color system with new tokens
173
+ docs: update installation instructions
174
+ chore: update dependencies
175
+ ```
176
+
177
+ ### Development Workflow
178
+
179
+ 1. Fork the repository
180
+ 2. Create a feature branch: `git checkout -b feat/my-feature`
181
+ 3. Make your changes
182
+ 4. Run type check: `bun run typecheck`
183
+ 5. Commit using conventional commits: `git commit -m "feat: add my feature"`
184
+ 6. Push to your fork: `git push origin feat/my-feature`
185
+ 7. Open a Pull Request
186
+
187
+ ## Release Process
188
+
189
+ This project uses [semantic-release](https://github.com/semantic-release/semantic-release) for automated versioning and publishing on NPM.
190
+
191
+ **How it works:**
192
+ - When commits are pushed to `main`, semantic-release analyzes commit messages
193
+ - Based on conventional commits, it determines the next version number
194
+ - Automatically updates `package.json` and generates `CHANGELOG.md`
195
+ - Creates a GitHub release with release notes
196
+ - Publishes the package to npm
197
+
198
+ **Version Bumping:**
199
+ - `fix:` commits → Patch release (1.0.0 → 1.0.1)
200
+ - `feat:` commits → Minor release (1.0.0 → 1.1.0)
201
+ - `BREAKING CHANGE:` → Major release (1.0.0 → 2.0.0)
202
+
136
203
  ## License
137
204
 
138
205
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cryterion/expo-chat-ui",
3
- "version": "1.0.2",
3
+ "version": "1.1.0",
4
4
  "description": "A reusable chat UI component for Expo + React Native applications",
5
5
  "author": "cryterion",
6
6
  "license": "MIT",
@@ -54,11 +54,16 @@
54
54
  },
55
55
  "devDependencies": {
56
56
  "@expo/vector-icons": "^14.1.0",
57
+ "@semantic-release/changelog": "^6.0.3",
58
+ "@semantic-release/git": "^10.0.1",
59
+ "@semantic-release/github": "^12.0.2",
60
+ "@semantic-release/npm": "^13.1.3",
57
61
  "@types/react": "^18.2.79",
58
62
  "expo": "^50.0.0",
59
63
  "expo-clipboard": "^7.0.0",
60
64
  "react": "18.2.0",
61
65
  "react-native": "0.73.6",
66
+ "semantic-release": "^25.0.2",
62
67
  "typescript": "~5.9.3"
63
68
  }
64
- }
69
+ }