Skip to content

Document the mainline-first branch workflow #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dblock merged 1 commit into from
Oct 27, 2026
Merged

Document the mainline-first branch workflow #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading