@@ -4,21 +4,21 @@ Releases in this repo are mostly automated using [release-plan](https://github.c
44
55## Preparation
66
7- Since the majority of the actual release process is automated, the remaining tasks before releasing are:
7+ Since the majority of the actual release process is automated, the remaining tasks before releasing are:
88
9- - correctly labeling ** all** pull requests that have been merged since the last release
10- - updating pull request titles so they make sense to our users
9+ - correctly labeling ** all** pull requests that have been merged since the last release
10+ - updating pull request titles so they make sense to our users
1111
1212Some great information on why this is important can be found at [ keepachangelog.com] ( https://keepachangelog.com/en/1.1.0/ ) , but the overall
1313guiding principle here is that changelogs are for humans, not machines.
1414
1515When reviewing merged PR's the labels to be used are:
1616
17- * breaking - Used when the PR is considered a breaking change.
18- * enhancement - Used when the PR adds a new feature or enhancement.
19- * bug - Used when the PR fixes a bug included in a previous release.
20- * documentation - Used when the PR adds or updates documentation.
21- * internal - Internal changes or things that don't fit in any other category.
17+ - breaking - Used when the PR is considered a breaking change.
18+ - enhancement - Used when the PR adds a new feature or enhancement.
19+ - bug - Used when the PR fixes a bug included in a previous release.
20+ - documentation - Used when the PR adds or updates documentation.
21+ - internal - Internal changes or things that don't fit in any other category.
2222
2323** Note:** ` release-plan ` requires that ** all** PRs are labeled. If a PR doesn't fit in a category it's fine to label it as ` internal `
2424
0 commit comments