From 0293b281090f74a5855678acbb3dc9a259ba7126 Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Wed, 9 Feb 2022 00:11:11 +0900 Subject: [PATCH] style(changelog): comply with MD022 and fix minor typos (#61) * style: add newlines after the title to comply with MD022 Signed-off-by: Kenji Miyake * style: replace whitespaces with whitespace Signed-off-by: Kenji Miyake --- .github/fixtures/cliff.toml | 4 ++-- .github/fixtures/expected.md | 1 + CHANGELOG.md | 1 + README.md | 14 +++++++++++++- config/cliff.toml | 4 ++-- examples/detailed.toml | 4 ++-- examples/keepachangelog.toml | 4 ++-- examples/scoped.toml | 4 ++-- examples/scopesorted.toml | 4 ++-- examples/unconventional.toml | 4 ++-- 10 files changed, 29 insertions(+), 15 deletions(-) diff --git a/.github/fixtures/cliff.toml b/.github/fixtures/cliff.toml index 40a40b2e72..01adea2962 100644 --- a/.github/fixtures/cliff.toml +++ b/.github/fixtures/cliff.toml @@ -3,7 +3,7 @@ [changelog] # changelog header header = """ -# Changelog +# Changelog\n All notable changes to this project will be documented in this file.\n """ # template for the changelog body @@ -21,7 +21,7 @@ body = """ {% endfor %} {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """ diff --git a/.github/fixtures/expected.md b/.github/fixtures/expected.md index a5f108016d..2d96ad5707 100644 --- a/.github/fixtures/expected.md +++ b/.github/fixtures/expected.md @@ -1,4 +1,5 @@ # Changelog + All notable changes to this project will be documented in this file. ## [0.2.0] - 2021-01-23 diff --git a/CHANGELOG.md b/CHANGELOG.md index faa6ca3810..4d8dca8cdc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog + All notable changes to this project will be documented in this file. ## [0.5.0] - 2021-12-15 diff --git a/README.md b/README.md index ba26ce1016..61822ad04d 100644 --- a/README.md +++ b/README.md @@ -375,7 +375,7 @@ See [templating](#templating) for more detail. #### trim -If set to `true`, leading and trailing whitespaces are removed from the [body](#body). +If set to `true`, leading and trailing whitespace are removed from the [body](#body). It is useful for adding indentation to the template for readability, as shown [in the example](#changelog). @@ -665,6 +665,7 @@ If you have a custom configuration file that you are using for your project(s), ``` # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -708,6 +709,7 @@ All notable changes to this project will be documented in this file. Rendered Output # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -813,6 +815,7 @@ All notable changes to this project will be documented in this file. ``` # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -858,6 +861,7 @@ All notable changes to this project will be documented in this file. Rendered Output # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -905,6 +909,7 @@ All notable changes to this project will be documented in this file. ``` # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -966,6 +971,7 @@ All notable changes to this project will be documented in this file. Rendered Output # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -1029,6 +1035,7 @@ All notable changes to this project will be documented in this file. ``` # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -1073,6 +1080,7 @@ All notable changes to this project will be documented in this file. Rendered Output # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -1119,6 +1127,7 @@ All notable changes to this project will be documented in this file. ``` # Changelog + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -1165,6 +1174,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Rendered Output # Changelog + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -1213,6 +1223,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ``` # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] @@ -1260,6 +1271,7 @@ All notable changes to this project will be documented in this file. Rendered Output # Changelog + All notable changes to this project will be documented in this file. ## [unreleased] diff --git a/config/cliff.toml b/config/cliff.toml index e57b38b17b..d1bbc1585a 100644 --- a/config/cliff.toml +++ b/config/cliff.toml @@ -3,7 +3,7 @@ [changelog] # changelog header header = """ -# Changelog +# Changelog\n All notable changes to this project will be documented in this file.\n """ # template for the changelog body @@ -21,7 +21,7 @@ body = """ {% endfor %} {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """ diff --git a/examples/detailed.toml b/examples/detailed.toml index bbafa0c19f..bb8616ecb1 100644 --- a/examples/detailed.toml +++ b/examples/detailed.toml @@ -3,7 +3,7 @@ [changelog] # changelog header header = """ -# Changelog +# Changelog\n All notable changes to this project will be documented in this file.\n """ # template for the changelog body @@ -27,7 +27,7 @@ body = """ {% endfor %} {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """ diff --git a/examples/keepachangelog.toml b/examples/keepachangelog.toml index d3765b399d..2cc18a9ef4 100644 --- a/examples/keepachangelog.toml +++ b/examples/keepachangelog.toml @@ -3,7 +3,7 @@ [changelog] # changelog header header = """ -# Changelog +# Changelog\n All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -24,7 +24,7 @@ body = """ {% endfor %} {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """ diff --git a/examples/scoped.toml b/examples/scoped.toml index d2ecc8ba64..0a3d2d3cf8 100644 --- a/examples/scoped.toml +++ b/examples/scoped.toml @@ -3,7 +3,7 @@ [changelog] # changelog header header = """ -# Changelog +# Changelog\n All notable changes to this project will be documented in this file.\n """ # template for the changelog body @@ -24,7 +24,7 @@ body = """ {% endfor %}\ {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """ diff --git a/examples/scopesorted.toml b/examples/scopesorted.toml index 28c8b5c75f..9ca9410db3 100644 --- a/examples/scopesorted.toml +++ b/examples/scopesorted.toml @@ -3,7 +3,7 @@ [changelog] # changelog header header = """ -# Changelog +# Changelog\n All notable changes to this project will be documented in this file.\n """ # template for the changelog body @@ -36,7 +36,7 @@ body = """ {% raw %}\n{% endraw %}\ {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """ diff --git a/examples/unconventional.toml b/examples/unconventional.toml index b6d6365e2b..f829797cf8 100644 --- a/examples/unconventional.toml +++ b/examples/unconventional.toml @@ -3,7 +3,7 @@ [changelog] # changelog header header = """ -# Changelog +# Changelog\n All notable changes to this project will be documented in this file.\n """ # template for the changelog body @@ -21,7 +21,7 @@ body = """ {% endfor %} {% endfor %}\n """ -# remove the leading and trailing whitespaces from the template +# remove the leading and trailing whitespace from the template trim = true # changelog footer footer = """