From 73acc93414c48670a3123efe6bc22334feb4857b Mon Sep 17 00:00:00 2001 From: Sterling Dreyer Date: Tue, 9 Dec 2025 11:31:15 -0800 Subject: [PATCH] Cursor versioning rules (#715) Rules to update versions of libraries that were changed and any dependencies if there are breaking changes --- > [!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`. > > 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). --------- Co-authored-by: Eric Gustin <34000337+EricGustin@users.noreply.github.com> --- .cursor/rules/versioning.mdc | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .cursor/rules/versioning.mdc diff --git a/.cursor/rules/versioning.mdc b/.cursor/rules/versioning.mdc new file mode 100644 index 00000000..1f7fdcf8 --- /dev/null +++ b/.cursor/rules/versioning.mdc @@ -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