Updates the CHANGELOG to be more uniform and specific. #694
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
One of my biggest take-aways from Google's technical writing course was "use more lists." I've tried to incorporate that here, breaking down changes into specific items. Another big change was being more specific and precise with the data structures in the SDK that have been updated. For example, we now list the effects that changed directly, specify fields that have changed more explicitly, and call out specific endpoints that we've introduced and their respective call builders.
marcelosalloum
approved these changes
Aug 31, 2021
CHANGELOG.md
Outdated
Comment on lines
72
to
86
| - The `ChangeTrustOperationResponse` has changed ([#688](https://github.com/stellar/js-stellar-sdk/pull/688)): | ||
| * `asset_type` can now be `liquidity_pool_shares` | ||
| * `asset_code` and `asset_issuer` are now optional | ||
| * `liquidity_pool_id` is a new optional field | ||
|
|
||
| - The trustline effects (`TrustlineCreated`, `TrustlineUpdated`, `TrustlineRevoked`) have changed ([#690](https://github.com/stellar/js-stellar-sdk/pull/690)): | ||
| * the asset type can now be `liquidity_pool_shares` | ||
| * they can optionally include a `liquidity_pool_id` | ||
|
|
||
| - Trustline sponsorship effects (`TrustlineSponsorshipCreated`, `TrustlineSponsorshipUpdated`, `TrustlineSponsorshipRemoved`) have been updated ([#690](https://github.com/stellar/js-stellar-sdk/pull/690)): | ||
| * the `asset` field is now optional, and is replaced by | ||
| * the `liquidity_pool_id` field for liquidity pools | ||
|
|
||
| - The `ChangeTrustOperationResponse` has changed ([#692](https://github.com/stellar/js-stellar-sdk/pull/692)): | ||
| * the `trustee` field is now optional |
There was a problem hiding this comment.
💡 There are two items referring to ChangeTrustOperationResponse breaking changes here. We should group them into a single item.
There was a problem hiding this comment.
Another excellent point 👍 done in 320ef43
Co-authored-by: Marcelo Salloum dos Santos <marcelo@stellar.org>
Shaptic
added a commit
that referenced
this pull request
Sep 2, 2021
* Use stellar-base 6.0.1 from the npm registry. * Correctly process transaction response for offers based on XDR changes (#681) * Adds a basic call builder for the `/liquidity_pools` endpoint. (#682) * Add call builder for liquidity pools, w/ filters by reserve asset * Update TradesCallBuilder to accept the trade_type filter and support Liquidity Pool trades (#685) * [CD/CI] Add GitHub Actions to run tests on PRs (#686) * Support filtering accounts participating in a given LP and update accounts balance response (#688) * Allow querying a single liquidity pool by its specific ID. (#687) * Allow querying actions (ops, txs, fx) related to a specific liquidity pool. (#689) * Add new effect types (#690) * Refactors call builders to simplify referencing 'neighbor' endpoints (#691) * Update with CAP-38 operations (#692) * Simplifies an expression to be more readable (#695) * Updates the CHANGELOG to be more uniform and specific. (#694) * Fix how the ?reserves filter works on the /accounts endpoint (#698) * Update more call builders to use the new helper API. (#699) * Add integration tests against the real mock API server (#697) * Prepares the v9.0.0 branch for merging into master (#701) * Update Horizon API fields to reflect the coming post-AMM API (#702) Co-authored-by: Marcelo Salloum dos Santos <marcelo@stellar.org> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: George Kudrayvtsev <george@stellar.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: I recommend previewing the file directly instead of looking at the diff.
Major edits include:
Overall, it should be easier for developers to digest the cumulative changes.