search

alexcrichton / ssh2-rs

Rust bindings for libssh2
https://docs.rs/ssh2
Apache License 2.0
489 stars 148 forks source link

Please keep a change log #136

Open koutheir opened 5 years ago

koutheir commented 5 years ago

Please keep a change log, so that projects that depend on this crate can manage updating efforts: keepachangelog.com.

crisidev commented 3 years ago

I think this is a good idea, but it will be best effort. What do you think @wez? I could work on a changelog for 0.8.3 and see if it is we can keep it up to date.

wez commented 3 years ago

I do agree that it is better to have a changelog than not have one, but there is a question of economics around the additional cost it imposes on the project maintainer(s).

For a busy project with a lot of granular changes a changelog can have value to the consumers, but for smaller projects with relatively infrequent changes it is redundant wrt. to the commit view on github. Also, while a lot of people claim to want more documentation, it is my long experience that almost nobody actually reads it, and that dilutes the value of the time of the person maintaining it.

I would bias towards maximizing the value/time ratio of the contributors while their time is scarce. If there is a glut of available time and collaborators then I think it is easier to justify the time to produce a changelog as an additional artifact.

crisidev commented 3 years ago

I think I agree with what you said here, especially with a release cycle like the one for this project.

koutheir commented 3 years ago

I think the choice between either keeping a detailed (git log like) change log or not keeping a change log at all is missing a lot of things in between. A change log that, at least, informs about breaking changes is very helpful, and I personally read those, because they usually provide hints about changes needed in clients in order to use the latest version of the library.