Scope & Objectives
...
On the Samvera Tech Call 2020-07-01, the call members acknowledged that there could be technical repercussions for changing a branch name that many of us have assumed as "ever present." As part of the working group's effort, they will gather known use cases and layout a plan to transition from "master" to a yet to be named default branch. At present, a current working understanding is that we would need to deprecate the use of "master" branch and allow downstream adopters a chance to adjust their implementations.
Working group members must have working knowledge of git branching or be prepared to learn more about git branching.
Deliverables & Timeframe
Narrative or bulleted text describing the tangible outcomes of the working group.
...
- A new "default branch" name that will replace "master"
- A date when the new "default branch" will be available on all projects
- A date when the "master" branch will no longer be available
- This should be coordinated with the Component Maintenance Working Group (Phase 1) to help ensure resources for the "master" removal date
- A document describing what to migrate or be aware of:
- Remediating developer clones
- Remediating forks (if necessary)
- Remediating gem references pointing to branches
- Should we send a community letter to Github about requests for feature?
It is possible that Github may implement features that mitigate or even automatically remediate the branch names.
Proposed Timeline (some of these may happen concurrently)
- WG Formation - 2 weeks
- Establish new default branch name - 1 week
- Gather use cases - 1 week
- Draft document - 1 week
- Review and ratify document - 1 week
- Implement new default branch name - 1 week
Meeting Times & Communication Channels
...
Note that Working Groups must have participants from three different Partners. All members of a working group producing software must be licensed Samvera contributors covered by the appropriate CLAs. Other types of contributions such as requirements, design, best practices, documentation, etc. - do not require CLAs but participants should accept that the materials to which they contribute may be released under a Creative Commons Attribution 4.0 International License..
- facilitator's name here, facilitator (facilitator's institution here)
- your name here (your institution here)