Document the JabKit Git merge driver

[koppor]

🤖 Sharing a library through Git produces line-based merge conflicts even when two people edit different entries. This adds a page describing how to register jabkit git merge-driver so Git merges bib files entry by entry, and how to finish the merges it cannot resolve. Low-risk documentation update; the driver itself is JabRef/jabref#16838.

🤖 Generated with Claude Code

https://claude.ai/code/session_014xQwRqLx2R27m7xFYPfAdK

[qodo-free-for-open-source-projects]

PR Summary by Qodo

Document JabKit semantic Git merge driver

📝 Documentation 🕐 Less than 10 minutes

AI Description

• Documents semantic entry- and field-level merging for shared Bib(la)TeX libraries.
• Explains global Git driver registration and repository-specific .gitattributes setup.
• Guides users through unsupported cases and remaining conflict resolution in JabRef.

Diagram

graph TD
  User["Git user"] --> Config["Global driver"] --> Git["Git merge"] --> Conflict{"Semantic conflict?"}
  Rules["Repository rules"] --> Git
  Conflict -- "No" --> Library["Merged library"]
  Conflict -- "Yes" --> Resolve["JabRef resolution"] --> Library

Loading

High-Level Assessment

A dedicated guide linked from the Share section is the best approach because setup and conflict handling form a complete workflow. Adding the material to the generic sharing or JabKit pages was considered, but would reduce discoverability and mix distinct concerns.

Files changed (2) +36 / -0

Documentation (2) +36 / -0

SUMMARY.mdAdd Git merge driver guide to Share navigation +1/-0

Add Git merge driver guide to Share navigation

• Adds the new semantic Git merge guide beneath the collaborative library-sharing documentation.

en/SUMMARY.md

git-merge-driver.mdDocument semantic bibliography merging with JabKit +35/-0

Document semantic bibliography merging with JabKit

• Introduces setup instructions for registering the JabKit Git merge driver and enabling it through '.gitattributes'. Explains automatic field-level merging, manual conflict resolution, and unsupported library changes.

en/collaborative-work/git-merge-driver.md

[qodo-free-for-open-source-projects]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX issues (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)

1. Command list omits Git ✓ Resolved 🐞 Bug ⚙ Maintainability

Description

The new page documents jabkit git merge-driver, while JabKit’s central “Available Commands”
listing still omits the git command. Users relying on that reference will incorrectly conclude
that the documented Git integration is unavailable.

Code

en/collaborative-work/git-merge-driver.md[13]

+git config --global merge.jabref.driver "jabkit git merge-driver --porcelain %O %A %B"

Evidence

The new guide explicitly introduces the git merge-driver command, while the main JabKit page’s
command enumeration lists all advertised commands but contains no git entry.

en/collaborative-work/git-merge-driver.md[12-16]
en/jabkit.md[71-88]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The central JabKit command reference does not list the newly documented `git` command, leaving two related documentation pages inconsistent.
## Issue Context
The merge-driver page invokes `jabkit git merge-driver`, but the “Available Commands” section in the main JabKit page presents an exhaustive-looking command list without `git`.
## Fix Focus Areas
- en/jabkit.md[71-88]
- en/collaborative-work/git-merge-driver.md[12-16]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

Tip of the day

💡 Did you know, you can add REVIEW.md to your repo root and Qodo follows it on every PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗