Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Provide changelog #62

Merged
merged 1 commit into from
Oct 24, 2022
Merged

Conversation

gilbertsoft
Copy link
Collaborator

No description provided.

@github-actions github-actions bot added documentation Improvements or additions to documentation maintenance labels Aug 14, 2022
@gilbertsoft gilbertsoft force-pushed the task/changelog branch 2 times, most recently from 4dd3c58 to b6fe384 Compare August 14, 2022 10:53
Copy link
Contributor

@oliverklee oliverklee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@gilbertsoft gilbertsoft force-pushed the task/changelog branch 3 times, most recently from 739f476 to d3cd7de Compare August 14, 2022 13:00
@gilbertsoft
Copy link
Collaborator Author

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.

@gilbertsoft gilbertsoft force-pushed the task/changelog branch 4 times, most recently from fde1c2c to e7f8951 Compare August 14, 2022 22:31
@oliverklee
Copy link
Contributor

@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
Copy link
Contributor

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

@gilbertsoft
Copy link
Collaborator Author

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.

@gilbertsoft gilbertsoft merged commit bb3faa1 into TYPO3:main Oct 24, 2022
@gilbertsoft gilbertsoft deleted the task/changelog branch October 24, 2022 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants