Skip to content

doc: add PR Reviewer Guide + visibility wiring (uniform with MobilityDB/MobilitySpark)#117

Open
estebanzimanyi wants to merge 1 commit intomainfrom
doc/reviewer-guide
Open

doc: add PR Reviewer Guide + visibility wiring (uniform with MobilityDB/MobilitySpark)#117
estebanzimanyi wants to merge 1 commit intomainfrom
doc/reviewer-guide

Conversation

@estebanzimanyi
Copy link
Copy Markdown
Member

@estebanzimanyi estebanzimanyi commented May 10, 2026

Summary

Adds doc/contributing/reviewer-guide.md for MobilityDuck, structurally identical to the MobilityDB and MobilitySpark guides at the same path:

Wires visibility so reviewers landing on the repo find the guide quickly:

  • .github/PULL_REQUEST_TEMPLATE.md — every new PR description starts with a banner pointing to the guide
  • README.md — new "For contributors and reviewers" section right before the Requirements section

The guide is updated in the same commit as any PR queue change (one-liner status change is enough; a fuller rewrite is needed when the dependency graph changes).

Cross-repo coordination

Companion PRs landing the same uniformization + visibility wiring:

Once all three merge, anyone landing in any of the three platform repos finds the same canonical guide at the same path.

Test plan

  • Render the guide on GitHub — tables and dependency chains display correctly
  • After merge, open a draft PR — verify the template banner appears
  • After merge, view the README on the repo home page — verify the "For contributors and reviewers" section appears

…policy

- Adds `doc/contributing/reviewer-guide.md` — single source of truth
  for reviewing open PRs.  Canonical structure shared with
  MobilityDB (PR #931) and MobilitySpark (PR #8): How to find this
  guide → CI legend (5 symbols incl. ⚠️) → Dependency chains →
  Tier 1/2/3 → Review checklist.

- Wires visibility for reviewers landing on the repo:
  - `.github/PULL_REQUEST_TEMPLATE.md` — banner appears in every new PR.
  - `README.md` — "For contributors and reviewers" section, links to
    the reviewer guide; mentions canonical cross-repo structure.

- Establishes the rule: every PR commit that changes queue state
  (opens/closes PR, discovers a dependency) updates the guide in the
  same commit.

Once this lands and companion PRs land on MobilityDB/MobilitySpark,
anyone landing in any of the three platform repos finds the same
canonical guide at the same path with consistent visibility through
the README and the PR template.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant