From 1bc1f08c4edb7db5753886815530c8f921cf02ef Mon Sep 17 00:00:00 2001 From: David Snelling Date: Fri, 1 Aug 2025 16:59:31 -0700 Subject: [PATCH] **chore(brainy-models): add version configuration and MIT license** - Added `.versionrc.json` to define conventional release configurations for `brainy-models-package`: - Configured tag prefix as `brainy-models-v`. - Defined custom commit message format and section mapping for release notes. - Added `LICENSE` file with MIT license for legal clarity. - Updated `README.md`: - Adjusted internal NPM script names to use underscore prefix for consistency (`_release:patch`, `_github-release`). **Purpose**: Establish standardized versioning, licensing, and script conventions for the `brainy-models-package` to improve maintainability and alignment with project standards. --- README.md | 6 ++--- brainy-models-package/.versionrc.json | 38 +++++++++++++++++++++++++++ brainy-models-package/LICENSE | 21 +++++++++++++++ 3 files changed, 62 insertions(+), 3 deletions(-) create mode 100644 brainy-models-package/.versionrc.json create mode 100644 brainy-models-package/LICENSE diff --git a/README.md b/README.md index 056d4542..129c2a3b 100644 --- a/README.md +++ b/README.md @@ -734,7 +734,7 @@ const vector = await db.embed("Some text to convert to a vector") // Calculate similarity between two texts or vectors const similarity = await db.calculateSimilarity( - "Cats are furry pets", + "Cats are furry pets", "Felines make good companions" ) console.log(`Similarity score: ${similarity}`) // Higher value means more similar @@ -1681,10 +1681,10 @@ If you need more control over the release process, you can use the individual co ```bash # Update version and generate changelog -npm run release:patch # or release:minor, release:major +npm run _release:patch # or _release:minor, _release:major # Create GitHub release -npm run github-release +npm run _github-release # Publish to NPM npm publish diff --git a/brainy-models-package/.versionrc.json b/brainy-models-package/.versionrc.json new file mode 100644 index 00000000..50d092cd --- /dev/null +++ b/brainy-models-package/.versionrc.json @@ -0,0 +1,38 @@ +{ + "tagPrefix": "brainy-models-v", + "commitMessageFormat": "chore(brainy-models): release {{currentTag}}", + "types": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "chore", + "hidden": true + }, + { + "type": "docs", + "section": "Documentation" + }, + { + "type": "style", + "hidden": true + }, + { + "type": "refactor", + "section": "Code Refactoring" + }, + { + "type": "perf", + "section": "Performance Improvements" + }, + { + "type": "test", + "hidden": true + } + ] +} diff --git a/brainy-models-package/LICENSE b/brainy-models-package/LICENSE new file mode 100644 index 00000000..9465500c --- /dev/null +++ b/brainy-models-package/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Soulcraft Research + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.