call-ai 0.2.0 → 0.2.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 +33 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -157,4 +157,36 @@ interface CallAIOptions {
|
|
|
157
157
|
|
|
158
158
|
## License
|
|
159
159
|
|
|
160
|
-
MIT or Apache-2.0, at your option
|
|
160
|
+
MIT or Apache-2.0, at your option
|
|
161
|
+
|
|
162
|
+
## Contributing and Release Process
|
|
163
|
+
|
|
164
|
+
### Development
|
|
165
|
+
|
|
166
|
+
1. Fork the repository
|
|
167
|
+
2. Make your changes
|
|
168
|
+
3. Add tests for new functionality
|
|
169
|
+
4. Run tests: `npm test`
|
|
170
|
+
5. Run type checking: `npm run typecheck`
|
|
171
|
+
6. Create a pull request
|
|
172
|
+
|
|
173
|
+
### Release Process
|
|
174
|
+
|
|
175
|
+
This library uses GitHub Actions to automate the release process:
|
|
176
|
+
|
|
177
|
+
1. Update the version in `package.json` (follow semver)
|
|
178
|
+
2. Update `CHANGELOG.md` with details of changes
|
|
179
|
+
3. Commit changes: `git commit -am "Release vX.Y.Z"`
|
|
180
|
+
4. Create a git tag: `git tag -a vX.Y.Z -m "Version X.Y.Z"`
|
|
181
|
+
5. Push changes and tag: `git push origin main vX.Y.Z`
|
|
182
|
+
|
|
183
|
+
The GitHub workflow in `.github/workflows/publish.yml` will:
|
|
184
|
+
- Automatically trigger when a new tag is pushed
|
|
185
|
+
- Run tests and type checking
|
|
186
|
+
- Verify the tag signature
|
|
187
|
+
- Publish the package to npm
|
|
188
|
+
|
|
189
|
+
When making significant changes, remember to:
|
|
190
|
+
- Document breaking changes in the changelog
|
|
191
|
+
- Update documentation to reflect API changes
|
|
192
|
+
- Update TypeScript types
|