search

marcocesarato / php-conventional-changelog

A PHP tool built to generate a changelog from a project's commit messages and metadata following the conventionalcommits.org and automate versioning with semver.org.
GNU General Public License v3.0
227 stars 32 forks source link

Missing blank line between changeLogVersionHeading and changelog content #39

Closed brunob closed 2 years ago

brunob commented 2 years ago

Markdown specs specify that headings should have blank lines before and after them ref https://www.markdownguide.org/basic-syntax/

This package doesn't do that see https://raw.githubusercontent.com/marcocesarato/php-conventional-changelog/main/CHANGELOG.md

## [1.15.0](https://github.com/marcocesarato/php-conventional-changelog/compare/v1.14.1...v1.15.0) (2022-06-02)
### Features

We can prevent this by adding the blank line after heading in config with 'changelogVersionFormat' => '## [{{version}}] - {{date}}'."\n", but maybe it would be better if the package does it by default. We can do that by adding ."\n" here https://github.com/marcocesarato/php-conventional-changelog/blob/main/src/Changelog.php#L366

Any thought about this ? Would you like a PR for that ?

marcocesarato commented 2 years ago

Hi, yes, as you explained, it should have another break line and it should be done by default.