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 don't think all of the items listed below in the changelog are necessary.
Mentioning only updated version numbers doesn't convey meaningful information. Instead, we should specify important changes, if any. Otherwise, no need to mention it.
Required versions should be release versions, not alpha versions, and it would be better to document them in the README as well.
Not every migration needs to be specified.
- Update giganto-client to version `0.17.0`. Updating to this version results
in the following changes.
- Bump dependencies.
- Update quinn to version `0.11`.
- Update rustls to version `0.23`.
- Fixed code and structures based on changes to the conn, http, smtp, ntlm,
ssh, tls protocols field.
- Update the compatibility version of the quic communication modules.
- Changed `PEER_VERSION_REQ` to ">=0.21.0-alpha.1,<0.22."
- Changed `INGEST_VERSION_REQ` to ">=0.21.0-alpha.1,<0.22."
- Changed `PUBLISH_VERSION_REQ` to ">=0.21.0-alpha.1,<0.22."
- Fixed code related to migration.
- Changed `COMPATIBLE_VERSION_REQ` to “>=0.21.0-alpha.1,<0.22.0”
- Added migration function in `migrate_0_19_to_0_21_0_alpha_1`. This feature
change values for conn, http, smtp, ntlm, ssh, tls protocol's fields in
versions `0.19.0` and later, and in versions prior to `0.21.0-alpha.1`.
Besides, there is one more same section:
- Update giganto-client to version `0.19.0`. Updating to this version results
in the following changes.
- Support bootp, dhcp events.
- Fixed code and structures based on changes to the conn protocols field.
- Update the compatibility version of the quic communication modules.
- Changed `PEER_VERSION_REQ` to ">=0.21.0-alpha.2,<0.22."
- Changed `INGEST_VERSION_REQ` to ">=0.21.0-alpha.2,<0.22."
- Changed `PUBLISH_VERSION_REQ` to ">=0.21.0-alpha.2,<0.22."
- Fixed code related to migration.
- Changed `COMPATIBLE_VERSION_REQ` to “>=0.21.0-alpha.2,<0.22.0”
- Added migration function in `migrate_0_21_0_alpha_1_to_0_21_0_alpha_2`.
This feature performs migration for changes to the conn protocol field
in version `0.21.0-alpha.2`.
Although not all of this part is necessary, there should be just one section with the most recent update if we insist on keeping it. (I don't mean keeping it as it is.) The changelog should specify what has changed from the previous release, not from individual commits, so simply listing what has been done needs to be corrected.
I don't think the below is necessary. We don't need to document internal and specific implementations that are unrelated to the user's point of view and that don't impact other parts.
- Changed the `from_key_value` macro to additionally receive `str_num_field`
for `StringNumber` conversion.
The below should be documented in the Fixed section, if it is a bug fix.
- Fixed to append the kind value to the filename when extracting a file for a
protocol for which a kind value exists.
The text was updated successfully, but these errors were encountered:
sehkone
changed the title
Correct items of README
Correct items of CHANGELOG
Sep 2, 2024
I don't think all of the items listed below in the changelog are necessary.
Besides, there is one more same section:
Although not all of this part is necessary, there should be just one section with the most recent update if we insist on keeping it. (I don't mean keeping it as it is.) The changelog should specify what has changed from the previous release, not from individual commits, so simply listing what has been done needs to be corrected.
I don't think the below is necessary. We don't need to document internal and specific implementations that are unrelated to the user's point of view and that don't impact other parts.
The below should be documented in the
Fixed
section, if it is a bug fix.- Fixed to append the kind value to the filename when extracting a file for a protocol for which a kind value exists.
The text was updated successfully, but these errors were encountered: