Keeping change log up to date

[ebkalderon]

I believe that in CONTRIBUTING.md, we should add under Pull Requests some conditions that make sure people's pull requests also update CHANGELOG.md to some degree so it doesn't have to be done manually.

What those conditions should be is up for discussion. Personally, I believe that we should look towards Semantic Versioning for ideas: if you fix a known bug, introduce new functionality, overhaul an existing feature, or produce a breaking change, you should document it appropriately in the change log.

See issue #17 from a while back for more information about the CHANGELOG.md format we use.

[White-Oak]

Just an oppinion, but I believe this should be done by a mantainer, not by pull requesters. Interesting to see, what others think.

[White-Oak]

Just an oppinion, but I believe this should be done by a mantainer, not by pull requesters. Interesting to see, what others think.

[ebkalderon]

@White-Oak I can see what you mean, just wanted to share an idea I've had floating around. I am curious, is there any kind of standard as to how maintainers should handle change log updates? Is it updated ad-hoc or done all at once?

[ebkalderon]

@White-Oak I can see what you mean, just wanted to share an idea I've had floating around. I am curious, is there any kind of standard as to how maintainers should handle change log updates? Is it updated ad-hoc or done all at once?

[White-Oak]

@ebkalderon I know rustc team puts a tag like 'changelog-notes' and uses that for a next release.

[White-Oak]

@ebkalderon I know rustc team puts a tag like 'changelog-notes' and uses that for a next release.

[ebkalderon]

I think this should remain the responsibility of the maintainer, since a stable change log should be part of a stable release schedule. We need to codify this on the wiki or in the CONTRIBUTING.md file, along with the branching model detailed in #27. Closing for now.

[ebkalderon]

I think this should remain the responsibility of the maintainer, since a stable change log should be part of a stable release schedule. We need to codify this on the wiki or in the CONTRIBUTING.md file, along with the branching model detailed in #27. Closing for now.