From 52f556c2fe987ad4b0f415e8429b724c48680355 Mon Sep 17 00:00:00 2001 From: "Daniel (dB.) Doubrovkine" Date: Tue, 27 Oct 2026 13:35:42 -0400 Subject: [PATCH] Document the mainline-first branch workflow Require shared changes to originate on master and be ported consistently to both actively maintained persistence branches, preserving their model-specific behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- AGENTS.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..9db1be7 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,11 @@ +# Branch workflow + +The mainline/default branch is named `master`, not `main`. Make shared changes in a pull request targeting `master` first, then port them consistently to `with-mongoid` and `with-activerecord`. + +All three branches are actively maintained. Keep shared code, examples, documentation, and CI aligned, with minimal branch-specific differences: + +- `master`: ActiveModel examples with generated data and no persistence. +- `with-mongoid`: MongoDB persistence, string IDs, and cursor/size pagination. +- `with-activerecord`: PostgreSQL persistence, integer IDs, and page/size pagination. + +Review and merge the mainline change before its branch-specific ports. Preserve each branch's intended behavior and validate the port against its database and supported compatibility matrix. Keep purely branch-specific fixes on the affected branch; do not introduce database dependencies into `master` or merge entire branches just to port a shared change.