I've added changes/next/TEMPLATE to the master branch, with some instructions and a templateish structure. Copy it, fill it out, commit it to your PR branch.
I expect we'll refine what we want as we go, but the point right now is to be capturing release/upgrade information while it's fresh in our minds, rather than hoping to remember it later. We probably don't need this stuff for PRs that are just bug fixes, but it wouldn't hurt to include it anyway for the habit and to see whether it feels worthwhile. On Wed, 13 Jan 2021, at 11:52 AM, Ricardo Signes wrote: > On Wed, Jan 6, 2021, at 19:38, Ricardo Signes wrote: >> 1. We make a directory in the repo called *upgrading*. >> 2. In that directory, we make a directory called *next*. >> 3. Feature branches are expected to add a file to upgrading/next that >> explains their upgrade requirements. >> 4. When v3.x.0 is being prepared, the release manager consolidates all the >> upgrading/next/* files into upgrading/v3.x.0 > > Having had a Cyrus call and a chat with ellie since this email, the final > resolution is: > * we call it "changes" and not "upgrading" > * we appreciate entries that say "this branch introduced no changes" because > they will save time when compiling the final document > * they should include not just "how to upgrade" but whatever unstructured > (but clear!) notes should be reflected in the final release notes > > -- > Ricardo Signes (rjbs) > CTO, Fastmail > > *Cyrus <https://cyrus.topicbox.com/latest>* / Devel / see discussions > <https://cyrus.topicbox.com/groups/devel> + participants > <https://cyrus.topicbox.com/groups/devel/members> + delivery options > <https://cyrus.topicbox.com/groups/devel/subscription> Permalink > <https://cyrus.topicbox.com/groups/devel/Taa08486771d9b334-M21348ce57cfbc795ebcfb3b9> ------------------------------------------ Cyrus: Devel Permalink: https://cyrus.topicbox.com/groups/devel/Taa08486771d9b334-M352b9aabbffb18d23ae65e5a Delivery options: https://cyrus.topicbox.com/groups/devel/subscription
