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

Add CHANGELOG.md #495

Closed
pellared opened this issue Jun 28, 2022 · 2 comments
Closed

Add CHANGELOG.md #495

pellared opened this issue Jun 28, 2022 · 2 comments
Labels
enhancement New feature or request
Milestone

Comments

@pellared
Copy link
Contributor

Can you consider adding a changelog? I find it easier to use than checking the GitHub release description. Also I find updating the changelog as part of PR a good practice.

Reference: https://keepachangelog.com/en/1.1.0/

@HofmeisterAn
Copy link
Collaborator

I don't see any advantages over https://github.com/testcontainers/testcontainers-dotnet/releases, but if we would like to track changes in a CHANGELOG, I'm fine with that.

@pellared
Copy link
Contributor Author

There are some pros and cons. From top of my head

Pros

  1. It is under version control. So e.g. they play well with forks.
  2. Finding something in a file may be easier than on a webpage (which UI can change). For example paging makes finding things harder.
  3. Can be useful to communicate unrealeased changes. For instance I try too look at changelog before making an issue (reading git history can be harder).

Cons:

  1. It has to be maintained and preferably in sync with GH Releases.

@HofmeisterAn HofmeisterAn added enhancement New feature or request RFD labels Jun 30, 2022
@HofmeisterAn HofmeisterAn added this to the 2.1.0 milestone Jun 30, 2022
@HofmeisterAn HofmeisterAn removed the RFD label Jul 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants