Comply with MD022?

[kenji-miyake]

Is your feature request related to a problem? Please describe.

The default configuration generates the changelog that violates a markdownlint rule MD022.

If there are no reasons for this, I feel it would be nice to comply with MD022.

Describe the solution you'd like

Just to add \n after # Changelog.

Before:

header = """
# Changelog
All notable changes to this project will be documented in this file.\n
"""

After:

header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""

Describe alternatives you've considered

Replace \n with a newline.

header = """
# Changelog

All notable changes to this project will be documented in this file.\n
"""

Additional context

Nothing.

[kenji-miyake]

@orhun How do you feel about it? If you don't mind, I'll send a PR.

[kenji-miyake]

Also, let me confirm one more small thing here.

The word whitespaces will cause a spell-check error, so can I replace it with whitespace or whitespace characters?

git-cliff/config/cliff.toml

Line 24 in e1da611

# remove the leading and trailing whitespaces from the template

Reference: https://english.stackexchange.com/questions/25368/what-is-the-plural-form-of-whitespace

[orhun]

@orhun How do you feel about it? If you don't mind, I'll send a PR.

Also, let me confirm one more small thing here.

The word whitespaces will cause a spell-check error, so can I replace it with whitespace or whitespace characters?

git-cliff/config/cliff.toml

Line 24 in e1da611

# remove the leading and trailing whitespaces from the template

Reference: english.stackexchange.com/questions/25368/what-is-the-plural-form-of-whitespace

Both things sound totally reasonable 👍🏼 Please go ahead and submit a PR.

[kenji-miyake]

@orhun Thank you, submitted #61.

By the way, there are some other rules that we can follow. How about these?
https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md#md004
https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md#md040

It is useful to use markdownlint-cli, Prettier, and pre-commit.ci

If you are interested, I can introduce them to this repository.

The sample settings are:
https://github.com/autowarefoundation/autoware/blob/27ba4d26c2597242f018da8f89b7126bba32825d/.markdownlint.yaml
https://github.com/autowarefoundation/autoware/blob/27ba4d26c2597242f018da8f89b7126bba32825d/.prettierrc.yaml
https://github.com/autowarefoundation/autoware/blob/27ba4d26c2597242f018da8f89b7126bba32825d/.pre-commit-config.yaml#L22-L31