Investigate patterns for a long-standing 'breaking changes' branch

Open
#7,240 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
git, github
Domain
devtools, release

Research direction

Start by investigating how a long-standing breaking-changes branch could stay aligned with main, using the merge-conflict, dual-pull-request, GitHub automation, and IDE tooling questions in the issue. Document a practical workflow and the tools or automation selected, including how ongoing changes should be handled.

Written by the indexing model from the issue text.

Description

To support a proactive approach to the next major release.

The primary concern to solve is finding the best way to keep this aligned with main. The majority of updates to main will be wanted on the new branch, but as the breaking changes accumulate it will not always be possible to merge without intervention.

  • Do we 'get good' at Git and stop thinking of merge-conflict as a dirty phrase?
  • If the above is unrealistic, does that mean changes need dual pull requests, one targeting each branch? Hopefully it won't come to that.
  • What GitHub automation and/or IDE tooling can we apply to this situation?
Dominant language
Python
Stars
724
Forks
317
Avg merge
3d 20h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SciTools/iris

All issues in SciTools/iris

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.