sync-remote

Sync Remote

Safe git sync workflow for manuscript repositories. Pushing build artifacts or skipping a pull can corrupt the remote project or cause hard-to-resolve conflicts. This is especially important for Overleaf-synced repositories, where Overleaf's git interface is strict about what it accepts.

Allowed File Types

Only stage files of these types. Never stage anything else:

*.tex  *.bib  *.cls  *.sty  *.bst  *.latexmkrc  *.eps  *.pdf (figures only)  *.svg  *.png
Makefile  Dockerfile  .gitignore  .claudeignore

Never stage:

• build/ — generated PDF and auxiliary files
• _minted-*/ — minted cache
• svg-inkscape/ — Inkscape export cache
• *.aux, *.log, *.out, *.fls, *.fdb_latexmk, *.synctex.gz

Pull Workflow (remote → local)

# 1. Check for local uncommitted changes first
git status

# 2. If clean, pull
git pull origin main

# 3. If conflicts arise — stop and report. Do not auto-resolve.

If there are local uncommitted changes before pulling: stash or commit them first, then pull, then reapply.

Push Workflow (local → remote)

# 1. Pull first — always
git pull origin main

# 2. Stage only allowed file types
# CUSTOMIZE: adjust glob patterns to match your project's source layout
git add *.tex *.bib figures/ svgs/ Makefile Dockerfile .gitignore .latexmkrc

# 3. Review what is staged
git status

# 4. Commit with standard message format (see below)
git commit -m "Edit: introduction — tighten contribution statements"

# 5. Push
git push origin main

Commit Message Format

<verb>: <section or scope> — <short description>

Verbs: Edit, Add, Fix, Remove, Rewrite, Restructure

Examples:

Edit: introduction — tighten contribution statements
Add: evaluation — ablation study subsection
Fix: method — correct notation for key variable
Rewrite: background — align with updated terminology