You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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:
Cons:
The text was updated successfully, but these errors were encountered: