Skip to content

Commit 9576726

Browse files
Jascha Franklin-Hodgehunterowens
authored andcommitted
Changes to reflect comments in PR and additional discussion.
1 parent 41b6718 commit 9576726

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

ReleaseGuidelines.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,17 @@ This *release branch* represents the current state of that release series. All m
4949

5050
When a PATCH release is ready (e.g. `0.2.0` to `0.2.1`), the release branch (e.g. `0.2.x`) is merged to `master` (to make the release official) and `dev` is rebased onto `master` (to ensure the patch is incorporated with any new work).
5151

52+
Breaking changes should always be merged to develop. These may be merged at any time and will be incorporated into the next minor release. For non-breaking changes, these should either be merged to develop if the next release is a minor release, or to the appropriate release branch if the next version is a patch release. During each cycle, we merge changes to both dev and 0.n.x branches, so breaking changes can be proposed and worked on at any time
53+
5254
As stated earlier, at this time MDS will maintain *two concurrent MINOR versions*. This means that when a MINOR release is made (e.g. `0.4.0`), work on the outgoing series (`0.2.x`, in this case) ceases and its release branch is removed.
5355

5456
## Release Process
5557
The sections below define the release process itself, including timeline, roles, and communication best practices.
5658

5759
> **The process defined below currently being piloted with the MDS `provider` API only. Proposed changes to the `agency` API will be continue to be reviewed on an ad hoc basis.**
5860
61+
>**It is our intent to maintain a level of coordination between the technical direction of `agency` and `provider`. As such, proposed changes to either API will be reviewed to ensure they do not create unnecessary duplicative functionality, introduce confusion about which API should be used for a given purpose, or prevent the reconciliation of data between the two APIs (for example: using data from `provider` to cross-validate data received via `agency`).**
62+
5963
### Goals
6064

6165
* _Fast, regular releases to support rapid evolution of MDS_

0 commit comments

Comments
 (0)