From 67994e49ffef793e553b2b672621c623665b906b Mon Sep 17 00:00:00 2001 From: NullVoxPopuli <199018+NullVoxPopuli@users.noreply.github.com> Date: Tue, 23 Jan 2024 15:38:11 -0500 Subject: [PATCH] lint:fix --- RELEASE.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 0ee061c..91c00ae 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -4,21 +4,21 @@ Releases in this repo are mostly automated using [release-plan](https://github.c ## Preparation -Since the majority of the actual release process is automated, the remaining tasks before releasing are: +Since the majority of the actual release process is automated, the remaining tasks before releasing are: -- correctly labeling **all** pull requests that have been merged since the last release -- updating pull request titles so they make sense to our users +- correctly labeling **all** pull requests that have been merged since the last release +- updating pull request titles so they make sense to our users Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall guiding principle here is that changelogs are for humans, not machines. When reviewing merged PR's the labels to be used are: -* breaking - Used when the PR is considered a breaking change. -* enhancement - Used when the PR adds a new feature or enhancement. -* bug - Used when the PR fixes a bug included in a previous release. -* documentation - Used when the PR adds or updates documentation. -* internal - Internal changes or things that don't fit in any other category. +- breaking - Used when the PR is considered a breaking change. +- enhancement - Used when the PR adds a new feature or enhancement. +- bug - Used when the PR fixes a bug included in a previous release. +- documentation - Used when the PR adds or updates documentation. +- internal - Internal changes or things that don't fit in any other category. **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`