Update Documentation for Go Driver Branching and Merge Strategies

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • None
    • Go Drivers
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Context

      This task involves updating the Go Driver documentation (probably in the CONTRIBUTING.md file) to provide clear guidelines on the merge strategies for evergreen configuration changes and bug targeting. Specifically, the updates should cover merging changes from release branches upwards to master, targeting bugs at the appropriate release branches, and optimizing the use of pull requests to manage cherry-picks effectively.

      Definition of done

      1. Evergreen Config Merge Strategy: Document the process of merging evergreen configuration changes starting from the release branch (e.g., release/2.0) and rolling up to the master branch. Presumably, evergreen changes should apply to all branches.
      2. Bug Targeting Guidelines: Clarify the strategy for pointing bugs at the correct release branch.
        • Current release branch for new bugs.
        • Point at 1.17 branch if the bug is also present in version 1.
      3. Pull Requests management:
        • Outline the best practices for grouping pull requests.
        • Explain how closing multiple merge-up pull requests (e.g., PR1, PR2) and grouping them into a final pull request (e.g., PR3) minimizes the number of individual pull requests, making management more streamlined.
      4. Documentation Format: Ensure the updated guidelines are clearly structured within the existing wiki documentation.
        • Provide step-by-step instructions where applicable.
        • Include examples to illustrate the strategies clearly.

      Pitfalls

      NA

            Assignee:
            Preston Vasquez
            Reporter:
            Preston Vasquez
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: