Skip to content

Commit 2f0f49d

Browse files
authored
Update README.md (#5581)
Add specific instructions for breaking changes. Fix some formatting.
1 parent b26c19e commit 2f0f49d

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

Diff for: package/README.md

+25-8
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,28 @@ Here is an overview of the release process. See the section below for detailed i
6767

6868
1. Assemble release notes.
6969

70-
* Since most changes are integrated into master using squash-rebase policy (i.e. one commit per PR), `git log --oneline` gives a good overview of changes in the release.
70+
* Since most changes are integrated into master using squash-rebase policy (i.e. one commit per PR), `git log --oneline` gives a good overview of changes in the release.
7171

72-
* Prepare release notes in Markdown format.
72+
* Prepare release notes in Markdown format.
7373

74-
* Combine related changes into the following categories, in that order:
74+
* For changes that are breaking, duplicate those changes and put the duplicate lines into a separate group called Breaking Changes. That group should go at the top of the Changelog. The original lines for the breaking changes should be marked by appending "(Breaking change)" to the line. Example:
75+
76+
```
77+
Breaking Changes
78+
================
79+
API xyz changed #1234
80+
...
81+
82+
Library - xyz
83+
=============
84+
API xyz changed #1234 (Breaking change)
85+
...
86+
```
87+
88+
89+
* Combine related changes into the following categories, in that order, including breaking changes with the appended mark:
7590
91+
- Breaking Changes
7692
- Core
7793
- *Libraries* — one section per library that received changes. If library only had a single change or a few changes, it is also okay to combine changes to a few such libraries under single "Other Libraries" entry.
7894
- Upstream dependencies
@@ -116,11 +132,12 @@ The following points assume work in a direct clone of the repository, and not in
116132
117133
10. Create a commit to the master branch, updating:
118134
119-
* The version in platform.txt file. This should correspond to the version of the *next* milestone, plus `-dev` suffix. E.g. `2.5.0-dev`.
135+
* The version in platform.txt file. This should correspond to the version of the *next* milestone, plus `-dev` suffix. E.g. `2.5.0-dev`.
120136
121-
* In main README.md:
137+
* In main README.md:
122138
123-
- in "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
124-
* In doc/conf.py
139+
- in "Latest release" section, change version number in the readthedocs link to the version which was just released, and verify that all links work.
140+
141+
* In doc/conf.py
125142
126-
- update version and release to the *next* milestone
143+
- update version and release to the *next* milestone

0 commit comments

Comments
 (0)