From 60425e790f84aaf284379fb598b6f9a586173976 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Colin=20Axn=C3=A9r?= <25233464+colin-axner@users.noreply.github.com> Date: Wed, 28 Sep 2022 14:04:35 +0200 Subject: [PATCH] chore: update migration template --- docs/migrations/migration-template.md | 13 ++++++------- docs/migrations/v4-to-v5.md | 2 +- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/migrations/migration-template.md b/docs/migrations/migration-template.md index 701b74290dd..277c5f00670 100644 --- a/docs/migrations/migration-template.md +++ b/docs/migrations/migration-template.md @@ -1,15 +1,14 @@ # Migrating from to -This document is intended to highlight significant changes which may require more information than presented in the CHANGELOG. -Any changes that must be done by a user of ibc-go should be documented here. +This guide provides instructions for migrating to a new version of ibc-go. There are four sections based on the four potential user groups of this document: -- Chains -- IBC Apps -- Relayers -- IBC Light Clients +- [Chains](#chains) +- [IBC Apps](#ibc-apps) +- [Relayers](#relayers) +- [IBC Light Clients](#ibc-light-clients) -**Note:** ibc-go supports golang semantic versioning and therefore all imports must be updated to bump the version number on major releases. +**Note:** ibc-go supports golang semantic versioning and therefore all imports must be updated on major version releases. ## Chains diff --git a/docs/migrations/v4-to-v5.md b/docs/migrations/v4-to-v5.md index f3fb7cfe33b..5565436fba0 100644 --- a/docs/migrations/v4-to-v5.md +++ b/docs/migrations/v4-to-v5.md @@ -7,7 +7,7 @@ There are four sections based on the four potential user groups of this document - [Chains](#chains) - [IBC Apps](#ibc-apps) - [Relayers](#relayers) -- [IBC Light Clients](#relayers) +- [IBC Light Clients](#ibc-light-clients) **Note:** ibc-go supports golang semantic versioning and therefore all imports must be updated to bump the version number on major releases. ```go