From 78c8057a1869148ea4f99bc1a279b4bd73699196 Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Tue, 3 Dec 2024 11:10:51 +0200 Subject: [PATCH] docs: fix typos in various documentation files (#22722) Co-authored-by: Julien Robert Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- CODING_GUIDELINES.md | 2 +- RELEASE_PROCESS.md | 4 ++-- ROADMAP.md | 4 ++-- docs/architecture/adr-008-dCERT-group.md | 2 +- docs/architecture/adr-033-protobuf-inter-module-comm.md | 2 +- docs/architecture/adr-049-state-sync-hooks.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index 59cd1e25e9b6..1e6d2a71270b 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -148,7 +148,7 @@ Desired outcomes: As a developer, you must help the QA team by providing instructions for User Experience (UX) and functional testing. -### QA Team to cross check Acceptance Tests +### QA Team to cross-check Acceptance Tests Once the AT are defined, the QA team will have an overview of the behavior a user can expect and: diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index e676be0d4ab1..d3b773e8dce4 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -27,7 +27,7 @@ v1.0.0-beta1 → v1.0.0-beta2 → ... → v1.0.0-rc1 → v1.0.0-rc2 → ... → * All links must point to their respective pull request. * The `CHANGELOG.md` must contain only the changes of that specific released version. All other changelog entries must be deleted and linked to the `main` branch changelog ([example](https://github.com/cosmos/cosmos-sdk/blob/release/v0.46.x/CHANGELOG.md#previous-versions)). * Create release notes, in `RELEASE_NOTES.md`, highlighting the new features and changes in the version. This is needed so the bot knows which entries to add to the release page on GitHub. - * Additionally verify that the `UPGRADING.md` file is up to date and contains all the necessary information for upgrading to the new version. + * Additionally verify that the `UPGRADING.md` file is up-to-date and contains all the necessary information for upgrading to the new version. * Remove GitHub workflows that should not be in the release branch * `test.yml`: All standalone go module tests should be removed (expect `./simapp`, and `./tests`, SDK and modules tests). * These packages are tracked and tested directly on main. @@ -57,7 +57,7 @@ A _patch release_ is an increment of the patch number (eg: `v1.2.0` → `v1.2.1` **Patch release must not break API nor consensus.** -Updates to the release branch should come from `main` by backporting PRs (usually done by automatic cherry pick followed by a PRs to the release branch). The backports must be marked using `backport/Y` label in PR for main. +Updates to the release branch should come from `main` by backporting PRs (usually done by automatic cherry-pick followed by PRs to the release branch). The backports must be marked using `backport/Y` label in PR for main. It is the PR author's responsibility to fix merge conflicts, update changelog entries, and ensure CI passes. If a PR originates from an external contributor, a core team member assumes responsibility to perform this process instead of the original author. diff --git a/ROADMAP.md b/ROADMAP.md index 86bd7e25c528..cc59ca813fbf 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -145,7 +145,7 @@ Issue: https://github.com/cosmos/iavl/issues/548 * Toolkit/SDK ADR. * Objective: - * Produce a RFC/ADR on how to make core composable + * Produce an RFC/ADR on how to make core composable * Merge RFC/ADR into main * Progress: * on pause until abci 2.0 integration is completed @@ -267,4 +267,4 @@ Issue: https://github.com/cosmos/iavl/issues/548 -This document will be updated at the end of the quarter on what was achieved and what was not. Shortly before the quarter concludes a new section will be added for the next quarter. We are working on updating the complete one year roadmap and will be posting it here as well. +This document will be updated at the end of the quarter on what was achieved and what was not. Shortly before the quarter concludes a new section will be added for the next quarter. We are working on updating the complete one-year roadmap and will be posting it here as well. diff --git a/docs/architecture/adr-008-dCERT-group.md b/docs/architecture/adr-008-dCERT-group.md index 13d2b340a667..509eb36234b4 100644 --- a/docs/architecture/adr-008-dCERT-group.md +++ b/docs/architecture/adr-008-dCERT-group.md @@ -101,7 +101,7 @@ mechanism. If those tokens are unbonded then the dCERT member must be automatically kicked from the group. Slashing of a particular dCERT member due to soft-contract breach should be -performed by governance on a per member basis based on the magnitude of the +performed by governance on a per-member basis based on the magnitude of the breach. The process flow is anticipated to be that a dCERT member is suspended by the dCERT group prior to being slashed by governance. diff --git a/docs/architecture/adr-033-protobuf-inter-module-comm.md b/docs/architecture/adr-033-protobuf-inter-module-comm.md index 4f2769e6770f..1929975c9a27 100644 --- a/docs/architecture/adr-033-protobuf-inter-module-comm.md +++ b/docs/architecture/adr-033-protobuf-inter-module-comm.md @@ -154,7 +154,7 @@ func (foo *FooMsgServer) Bar(ctx context.Context, req *MsgBarRequest) (*MsgBarRe } ``` -This design is also intended to be extensible to cover use cases of more fine grained permissioning like minting by +This design is also intended to be extensible to cover use cases of more fine-grained permissioning like minting by denom prefix being restricted to certain modules (as discussed in [#7459](https://github.com/cosmos/cosmos-sdk/pull/7459#discussion_r529545528)). diff --git a/docs/architecture/adr-049-state-sync-hooks.md b/docs/architecture/adr-049-state-sync-hooks.md index 50c551ea2b8d..5a896613cbb9 100644 --- a/docs/architecture/adr-049-state-sync-hooks.md +++ b/docs/architecture/adr-049-state-sync-hooks.md @@ -116,7 +116,7 @@ type ExtensionPayloadReader = func() ([]byte, error) type ExtensionPayloadWriter = func([]byte) error // ExtensionSnapshotter is an extension Snapshotter that is appended to the snapshot stream. -// ExtensionSnapshotter has an unique name and manages it's own internal formats. +// ExtensionSnapshotter has a unique name and manages it's own internal formats. type ExtensionSnapshotter interface { // SnapshotName returns the name of snapshotter, it should be unique in the manager. SnapshotName() string