-
Notifications
You must be signed in to change notification settings - Fork 637
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
docs: add changelog for callbacks and 08-wasm #5910
Changes from all commits
491ce37
2892c12
1e9fb11
e84c821
5b1fbfd
1ec0dcc
75bcfcc
84da8c1
5d9381e
6277461
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,63 @@ | ||||||
<!-- | ||||||
Guiding Principles: | ||||||
|
||||||
Changelogs are for humans, not machines. | ||||||
There should be an entry for every single version. | ||||||
The same types of changes should be grouped. | ||||||
Versions and sections should be linkable. | ||||||
The latest version comes first. | ||||||
The release date of each version is displayed. | ||||||
Mention whether you follow Semantic Versioning. | ||||||
|
||||||
Usage: | ||||||
|
||||||
Change log entries are to be added to the Unreleased section under the | ||||||
appropriate stanza (see below). Each entry should ideally include a tag and | ||||||
the Github issue reference in the following format: | ||||||
|
||||||
* (<tag>) \#<issue-number> message | ||||||
|
||||||
The issue numbers will later be link-ified during the release process so you do | ||||||
not have to worry about including a link manually, but you can if you wish. | ||||||
|
||||||
Types of changes (Stanzas): | ||||||
|
||||||
"Features" for new features. | ||||||
"Improvements" for changes in existing functionality. | ||||||
"Deprecated" for soon-to-be removed features. | ||||||
"Bug Fixes" for any bug fixes. | ||||||
"Client Breaking" for breaking CLI commands and REST routes used by end-users. | ||||||
"API Breaking" for breaking exported APIs used by developers building on SDK. | ||||||
"State Machine Breaking" for any changes that result in a different AppState given the same genesisState and txList. | ||||||
Ref: https://keepachangelog.com/en/1.0.0/ | ||||||
--> | ||||||
|
||||||
# Changelog | ||||||
|
||||||
## [Unreleased] | ||||||
|
||||||
### Dependencies | ||||||
|
||||||
### API Breaking | ||||||
|
||||||
### State Machine Breaking | ||||||
|
||||||
### Improvements | ||||||
|
||||||
### Features | ||||||
|
||||||
### Bug Fixes | ||||||
|
||||||
<!-- markdown-link-check-disable-next-line --> | ||||||
## [v0.2.0+ibc-go-v8.0](https://github.com/cosmos/ibc-go/releases/tag/modules%2Fapps%2Fcallbacks%2Fv0.2.0%2Bibc-go-v8.0) - 2023-11-15 | ||||||
|
||||||
### Bug Fixes | ||||||
|
||||||
* [\#4568](https://github.com/cosmos/ibc-go/pull/4568) Include error in event that is emitted when the callback cannot be executed due to a panic or an out of gas error. Packet is only sent if the `IBCSendPacketCallback` returns nil explicitly. | ||||||
|
||||||
<!-- markdown-link-check-disable-next-line --> | ||||||
## [v0.1.0+ibc-go-v7.3](https://github.com/cosmos/ibc-go/releases/tag/modules%2Fapps%2Fcallbacks%2Fv0.1.0%2Bibc-go-v7.3) - 2023-08-31 | ||||||
|
||||||
### Features | ||||||
|
||||||
* [\#3939](https://github.com/cosmos/ibc-go/pull/3939) feat(callbacks): ADR8 implementation. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It appears that a white space is missing after "feat(callbacks):" in the feature description for version - feat(callbacks): ADR8 implementation.
+ feat(callbacks): ADR8 implementation. Note: The suggested change visually appears identical due to the nature of the issue (missing whitespace). Please ensure a space is added after the colon in the actual document. Committable suggestion
Suggested change
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
<!-- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. do we add this preamble for callbacks too? |
||
Guiding Principles: | ||
|
||
Changelogs are for humans, not machines. | ||
There should be an entry for every single version. | ||
The same types of changes should be grouped. | ||
Versions and sections should be linkable. | ||
The latest version comes first. | ||
The release date of each version is displayed. | ||
Mention whether you follow Semantic Versioning. | ||
|
||
Usage: | ||
|
||
Change log entries are to be added to the Unreleased section under the | ||
appropriate stanza (see below). Each entry should ideally include a tag and | ||
the Github issue reference in the following format: | ||
|
||
* (<tag>) \#<issue-number> message | ||
|
||
The issue numbers will later be link-ified during the release process so you do | ||
not have to worry about including a link manually, but you can if you wish. | ||
|
||
Types of changes (Stanzas): | ||
|
||
"Features" for new features. | ||
"Improvements" for changes in existing functionality. | ||
"Deprecated" for soon-to-be removed features. | ||
"Bug Fixes" for any bug fixes. | ||
"Client Breaking" for breaking CLI commands and REST routes used by end-users. | ||
"API Breaking" for breaking exported APIs used by developers building on SDK. | ||
"State Machine Breaking" for any changes that result in a different AppState given the same genesisState and txList. | ||
Ref: https://keepachangelog.com/en/1.0.0/ | ||
--> | ||
|
||
# Changelog | ||
|
||
## [Unreleased] | ||
|
||
### Dependencies | ||
|
||
### API Breaking | ||
|
||
### State Machine Breaking | ||
|
||
### Improvements | ||
|
||
### Features | ||
|
||
* [#\5821](https://github.com/cosmos/ibc-go/pull/5821) feat: add `VerifyMembershipProof` RPC query (querier approach for conditional clients). | ||
|
||
### Bug Fixes | ||
|
||
<!-- markdown-link-check-disable-next-line --> | ||
## [v0.1.0+ibc-go-v8.0-wasmvm-v1.5](https://github.com/cosmos/ibc-go/releases/tag/modules%2Flight-clients%2F08-wasm%2Fv0.1.0%2Bibc-go-v7.3-wasmvm-v1.5) - 2023-12-18 | ||
|
||
### Features | ||
|
||
* [\#5079](https://github.com/cosmos/ibc-go/pull/5079) feat: 08-wasm light client proxy module for wasm clients. | ||
|
||
<!-- markdown-link-check-disable-next-line --> | ||
## [v0.1.0+ibc-go-v7.3-wasmvm-v1.5](https://github.com/cosmos/ibc-go/releases/tag/modules%2Flight-clients%2F08-wasm%2Fv0.1.0%2Bibc-go-v8.0-wasmvm-v1.5) - 2023-12-18 | ||
|
||
### Features | ||
|
||
* [\#5079](https://github.com/cosmos/ibc-go/pull/5079) feat: 08-wasm light client proxy module for wasm clients. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a possible spelling mistake in the description of the bug fix for version
v0.2.0+ibc-go-v8.0
. The term "f gas error" might be a typo. If it's intended to refer to an "out of gas error," please ensure clarity and correctness in the terminology used.