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

Remove CHANGELOG files #25

Open
peterschewe opened this issue Jul 2, 2022 · 2 comments
Open

Remove CHANGELOG files #25

peterschewe opened this issue Jul 2, 2022 · 2 comments
Milestone

Comments

@peterschewe
Copy link
Contributor

We can remove the CHANGELOG files as the usage is not currently kept consistent and up to date. The changes are also logged in the GitHub release notes.

TBD: We could keep a CHANGELOG template without demo content (e.g. https://keepachangelog.com/en/1.0.0/). However, I rarely see it used in our projects. What do you think @bezoerb?

Todos:

  • Delete templates/app/CHANGELOG.md
  • Delete templates/theme-default/CHANGELOG.md
@peterschewe peterschewe added the good first issue Good for newcomers label Jul 2, 2022
@bezoerb
Copy link
Member

bezoerb commented Jul 2, 2022

Or we start using it even if it is not actively requested by the client

@peterschewe peterschewe removed the good first issue Good for newcomers label Jul 2, 2022
@peterschewe
Copy link
Contributor Author

peterschewe commented Jul 2, 2022

Yes, we can try it.

I have also misunderstood the structure of our changelogs. We use the following to track the changes of the individual packages:

  • ./CHANGELOG.md
  • ./packages/contentful-migrations/CHANGELOG.md
  • ./packages/create-wekit-app/CHANGELOG.md
  • ./templates/app/CHANGELOG.md
  • ./templates/theme-default/CHANGELOG.md

So we could remove the specific WEKit changes in templates/app/CHANGELOG.md and keep it as a changelog template for the project scaffold. Not entirely consistent with the others. 🤔

@peterschewe peterschewe added this to the Clean up milestone Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants