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

Maintaining a Changelog #151

Open
Pharap opened this issue Aug 6, 2016 · 0 comments
Open

Maintaining a Changelog #151

Pharap opened this issue Aug 6, 2016 · 0 comments

Comments

@Pharap
Copy link

Pharap commented Aug 6, 2016

I recently read a two person debate that unfolded during a PR that got closed and there were a number of important issues raised. In response to this, to ensure that the issues are not forgotten, I am making an attempt to bring at least one of these issues to attention.

In particular, this comment by @MLXXXp brought to my attention that the library does not have a current changelog system. As someone who is used to playing early access games, this struck me as being an important void that should be filled as I've seen it work well for said games.

Personally I do not currently have a preference for how such a changelog system should be maintained, but here's a brief list of some pros and cons I can see with making such a change:

Pros:

  • It provides a nice brief digest of the changes for people who use the library but do not actively watch or participate in the development
  • It provides a means of documenting features and bugfixes as separate entities
  • It could potentially be put together from a list of (hopefully well described) commits
  • It can be added to alongside each commit to ensure it is not forgotten

Cons:

  • Remembering to update the changelog adds extra work
  • Users who are unaware of the changelog might forget to update it
  • It is a potential source for merge conflicts
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

1 participant