From 040b0acbd250b4e39066dfb29ca8621cf1a601a6 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 10 May 2021 16:36:58 -0500 Subject: [PATCH 1/5] add mention for CHANGELOG.next in steps --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 766f1a1bc2..f23551c74f 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! From 70be1421dd4058da0f50d84d9f4d464cce01eb82 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 10 May 2021 16:37:24 -0500 Subject: [PATCH 2/5] refactor sections --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f23551c74f..1bcefc981f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,16 +97,16 @@ 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 - -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. - -#### Branching +### Branching * 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. +### 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 Refer to the backport tool's [repo](https://github.com/sqren/backport#requirements) for requirements and install guide. A [project config](.backportrc.json) is maintained in the root of this repo. From 1ffd2fbc5d0638feff288538c74c583d2c14cb66 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 10 May 2021 16:42:50 -0500 Subject: [PATCH 3/5] refactor branching descriptions --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1bcefc981f..558d6fde1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,9 +99,11 @@ Please follow these guidelines when submitting Issues: ### Branching -* 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. +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. ### Backports From 9174e59b6cfe4e25b6ac51d14719d70dc83a6153 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Tue, 11 May 2021 11:17:26 -0500 Subject: [PATCH 4/5] add section detailing CHANGELOG conventions --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 558d6fde1f..4af171b7c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -105,6 +105,15 @@ ECS follows this branching strategy: * 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: + +* [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. + +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. From 0b82cb9fc8966acb45d4155545c4094c9bccdf00 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Tue, 11 May 2021 11:17:42 -0500 Subject: [PATCH 5/5] consolidate breaking changes section --- CHANGELOG.next.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) 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