Cursor versioning rules (#715)
Rules to update versions of libraries that were changed and any dependencies if there are breaking changes <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds `.cursor/rules/versioning.mdc` with semver rules and dependency graph for the arcade libraries. > > - **Docs**: > - Add `.cursor/rules/versioning.mdc`: > - Defines semver rules and when to bump library and dependency versions. > - Documents dependency graph for `arcade-core`, `arcade-tdk`, `arcade-serve`, `arcade-mcp-server`, and `arcade-mcp`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 6974d4ffc6f238bd0a56d0f88fc8005560e00018. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Eric Gustin <34000337+EricGustin@users.noreply.github.com>
This commit is contained in:
parent
bdb7163313
commit
73acc93414
1 changed files with 25 additions and 0 deletions
25
.cursor/rules/versioning.mdc
Normal file
25
.cursor/rules/versioning.mdc
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
description: Guidelines for library versioning
|
||||||
|
alwaysApply: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Versioning
|
||||||
|
This repository contains 5 libraries: arcade-core, arcade-tdk, arcade-serve, arcade-mcp-server, and arcade-mcp (CLI)
|
||||||
|
|
||||||
|
## Dependency graph recap:
|
||||||
|
1. arcade-core
|
||||||
|
- The base library
|
||||||
|
2. arcade-tdk
|
||||||
|
- Depends on: arcade-core
|
||||||
|
3. arcade-serve
|
||||||
|
- Depends on: arcade-core
|
||||||
|
4. arcade-mcp-server
|
||||||
|
- Depends on: arcade-core, arcade-serve, arcade-tdk
|
||||||
|
5. arcade-mcp
|
||||||
|
- Depends on: arcade-mcp-server, arcade-core
|
||||||
|
- Dev/optional deps: arcade-serve, arcade-tdk
|
||||||
|
|
||||||
|
## Rules
|
||||||
|
- ALWAYS use semver (semantic versioning)
|
||||||
|
- ALWAYS increase the version of a library in pyproject.toml when a library's code is modified.
|
||||||
|
- ALWAYS increase the minimum required version of dependencies if there is a breaking change between dependencies
|
||||||
Loading…
Reference in a new issue