Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate Breaking changes sections in CHANGELOG.next #1408

Merged
merged 7 commits into from
May 12, 2021
Merged

Consolidate Breaking changes sections in CHANGELOG.next #1408

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
040b0ac
add mention for CHANGELOG.next in steps
ebeahan May 10, 2021
70be142
refactor sections
ebeahan May 10, 2021
1ffd2fb
refactor branching descriptions
ebeahan May 10, 2021
9174e59
add section detailing CHANGELOG conventions
ebeahan May 11, 2021
0b82cb9
consolidate breaking changes section
ebeahan May 11, 2021
7c8225e
Merge branch 'master' into improve-changelog-guidance
ebeahan May 11, 2021
1327f13
Merge branch 'master' into improve-changelog-guidance
ebeahan May 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions CHANGELOG.next.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Thanks, you're awesome :-) -->

## Unreleased

### Schema Changes
### Breaking Changes

#### Breaking changes
### Schema Changes

#### Bugfixes

Expand All @@ -24,8 +24,6 @@ Thanks, you're awesome :-) -->

### Tooling and Artifact Changes

#### Breaking changes

#### Bugfixes

#### Added
Expand Down
24 changes: 18 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down Expand Up @@ -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 `<major>.x` is the next minor version and gets backports of most non-breaking features and fixes.
* The `<major>.<minor>` 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

Expand Down