search

TYPO3 / coding-standards

TYPO3 Coding Standards to be used by TYPO3 projects or extensions
MIT License
52 stars 16 forks source link

[DOCS] Provide changelog #62

Closed gilbertsoft closed 1 year ago

gilbertsoft commented 2 years ago

We should add this file to the .gitattributes so that this file doesn’t get packaged.

Not sure if I agree here: as a developer I like to find this kind of information, like also the docs, in the package to be able to make necessary changes efficiently without having to look them up somewhere online. The TYPO3 core also includes this information in the dist see https://github.com/TYPO3/typo3/blob/main/typo3/sysext/core/.gitattributes. And imho this is exactly the use case of a changelog, having it local and not have to lookup somewhere online also in case of no internet connection.

oliverklee commented 2 years ago

@gilbertsoft At least I personally have never looked at a changelog or README for a package in the local installed dependency - I have always looked for them on GitHub.

I see that you're using changelogs differently, though. ;-)

oliverklee commented 2 years ago

(I have on idea whether there is some convention there.)

gilbertsoft commented 1 year ago

I see that you're using changelogs differently, though. ;-)

Yeah, I'm always try to keep the efforts low. E.g. Symfony also includes the changelog and I have regularly hits in the changelog when looking for breaking changes.