diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index be936302d8..4f42b98d32 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -8,9 +8,9 @@ Thanks, you're awesome :-) --> ## Unreleased -### Schema Changes +### Breaking Changes -#### Breaking changes +### Schema Changes #### Bugfixes @@ -24,8 +24,6 @@ Thanks, you're awesome :-) --> ### Tooling and Artifact Changes -#### Breaking changes - #### Bugfixes #### Added diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 766f1a1bc2..4af171b7c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,6 +61,7 @@ You need these tools to contribute to the ECS repo: * Request feedback about your changes. - Create a [Pull Request](https://help.github.com/articles/creating-a-pull-request/) against the ECS repo. - (Look for the `Compare & pull request` button on your branch in github.com.) + - Add an entry to [CHANGELOG.next.md](CHANGELOG.next.md). - Wait for reviews on your PR. - Incorporate review comments and push updates if needed. * Thank you for your contribution! @@ -96,15 +97,26 @@ Please follow these guidelines when submitting Issues: * Click `New issue`. Provide as many details as possible to help reviewers and other contributors understand your proposal. * Add your text, and click `Submit new issue`. -### Backports +### Branching -ECS maintains multiple release branches in the repo. The `master` branch is where all new contributions should be submitted, and features and bug fixes will be backported into other branches when appropriate. Any backporting needs will be handled by the ECS team. +ECS follows this branching strategy: + +* The `master` is the next major version. It is where all new contributions are first merged. This includes new features and bug fixes, and it may also include breaking changes. +* The `.x` is the next minor version and gets backports of most non-breaking features and fixes. +* The `.` is the next release of a minor version, including patch releases. + +### Changelog + +ECS maintains two changelog files: -#### Branching +* [CHANGELOG.md](CHANGELOG.md) contains a list of notable changes for each released version of ECS. +* [CHANGELOG.next.md](CHANGELOG.next.md) contains a list of unreleased ECS changes. -* The `master` branch is where all new contributions are merged. This includes new features and bug fixes, and it may also include breaking changes. -* The `1.x` branch gets backports of most non-breaking features and fixes. This branch represents the next `major.minor` release. -* The `major.minor` branches (e.g. `1.6`, `1.5`, `1.4`, etc.) contain the latest released version of those releases. +Breaking changes intended for the next major version should be included underneath the `Breaking changes` sections in `CHANGELOG.next.md`. + +### Backports + +ECS maintains multiple release branches in the repo. The `master` branch is where all new contributions should be submitted, and features and bug fixes will be backported into other branches when appropriate. Any backporting needs will be handled by the ECS team. #### Tooling