|
|
This How-To guide is for CR authors who are want to start drafting changes but don't yet have a CR number (and therefore can't start a [proper CR branch](How-To/Create-a-CR.md#make-a-new-CR-branch))
|
|
|
This How-To guide is for CR authors who are want to start drafting changes but don't yet have a CR number (and therefore can't start a [proper CR branch](How-To/Create-a-CR#make-a-new-CR-branch))
|
|
|
|
|
|
## Setting up the draft branch
|
|
|
|
... | ... | @@ -11,7 +11,7 @@ Set the details as follows: |
|
|
| Field | Description | Example |
|
|
|
| -- | -- | -- |
|
|
|
| Branch name | Start with `draft/` followed by something descriptive. A good convention to follow is using your initials and the spec you are drafting a change for| `draft/msc_103120` |
|
|
|
| Create from | Choose the [current meeting branch](Conventions/Branching-conventions.md), if available, otherwise `main` | `main` |
|
|
|
| Create from | Choose the [current meeting branch](Conventions/Branching-conventions), if available, otherwise `main` | `main` |
|
|
|
|
|
|
> If you create a draft branch from `main` rather than a current meeting branch, you may need to take some extra steps when you come to [turn your draft into a real CR](#convert-a-draft-branch-to-a-cr-branch). If at all possible, create from the latest meeting branch. If there is no current meeting branch, and you think there should be one, contact the [maintainers](Maintainers.md).
|
|
|
|
... | ... | @@ -29,7 +29,7 @@ The preflight stage and the artefact generation stage are both skipped; for thes |
|
|
|
|
|
Once you have a CR number from the technical officer, you are ready to create a real CR branch.
|
|
|
|
|
|
First, follow the instructions in the [Create a CR How-To](How-To/Create-a-CR.md), up to the point that you have created a branch and a Merge Request, but before you have made any changes.
|
|
|
First, follow the instructions in the [Create a CR How-To](How-To/Create-a-CR), up to the point that you have created a branch and a Merge Request, but before you have made any changes.
|
|
|
|
|
|
Then, create a Merge Request *from* your draft branch *to* your draft branch.
|
|
|
|
... | ... | @@ -64,7 +64,7 @@ If you used the latest meeting branch as the basis for your draft branch, then y |
|
|
|
|
|
If you used `main` as the latest meeting branch, then you may find that your branch needs to be rebased before you can merge it. The Forge may be able to do this for you automatically; if so, there will be a blue "rebase" button. Click this, and once the rebase has completed, you should be able to click the "Merge" button as above.
|
|
|
|
|
|
If the Forge can't rebase your branch, it will tell you so. At this point, you will either need to rebase or merge the branches yourself via the Git command line, or contact one of the [maintainers](Maintainers.md) to help you out.
|
|
|
If the Forge can't rebase your branch, it will tell you so. At this point, you will either need to rebase or merge the branches yourself via the Git command line, or contact one of the [maintainers](Maintainers) to help you out.
|
|
|
|
|
|
## Remove the draft branch
|
|
|
|
... | ... | |