Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2479

Require squash-merging for specifications PRs

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Works as Designed
    • Icon: Minor - P4 Minor - P4
    • None
    • GitHub
    • None
    • Not Needed

    Description

      Summary

      This came up in a comment on the scope doc (WRITING-12027) for automated spec testing (DRIVERS-1304). Since that project may trigger on commits in the specifications repository, it may be helpful to require PRs to use squash-merging. Some other drivers (e.g. PHP, Ruby) already require this of PRs and prohibit merge commits and rebases via GitHub's UI.

      In rare cases where a PR is intentionally organized into separate commits (sometimes the case with small fixes for multiple DRIVERS tickets), authors can fall back to manually rebasing and merging via the command line (likely a fast-forward w/o a merge commit). If that's agreeable, we can note this in a CONTRIBUTING document.

      Motivation

      Is this issue urgent?

      No, although it may be helpful to address this before or alongside DRIVERS-1304.

      Is this ticket required by a downstream team?

      No.

      Is this ticket only for tests?

      No.

      Attachments

        Activity

          People

            Unassigned Unassigned
            jmikola@mongodb.com Jeremy Mikola
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: