Skip to content

Commit 7b5d3e5

Browse files
authored
docs: fix typos (#20734)
1 parent cbef415 commit 7b5d3e5

6 files changed

+19
-19
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ contributors, the general procedure for contributing has been established:
4343
1. Ensure that the proposal has been accepted.
4444
2. Ensure that nobody else has already begun working on this issue. If they have,
4545
make sure to contact them to collaborate.
46-
3. If nobody has been assigned for the issue and you would like to work on it,
46+
3. If nobody has been assigned to the issue and you would like to work on it,
4747
make a comment on the issue to inform the community of your intentions
4848
to begin work.
4949
5. To submit your work as a contribution to the repository follow standard GitHub best practices. See [pull request guideline](#pull-requests) below.
@@ -322,11 +322,11 @@ to developers who show an aptitude towards developing with this code base.
322322

323323
Several different kinds of privileges may be granted however most common
324324
privileges to be granted are merge rights to either part of, or the entirety of the
325-
code base (through the GitHub `CODEOWNERS` file). The on-boarding process for
325+
code base (through the GitHub `CODEOWNERS` file). The onboarding process for
326326
new code owners is as follows: On a bi-monthly basis (or more frequently if
327327
agreeable) all the existing code owners will privately convene to discuss
328328
potential new candidates as well as the potential for existing code-owners to
329-
exit or "pass on the torch". This private meeting is to be a held as a
329+
exit or "pass on the torch". This private meeting is to be held as a
330330
phone/video meeting.
331331

332332
Subsequently after the meeting, and pending final approval from the ICF,

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Core Dependencies are the core libraries that an application may depend on.
7878

7979
#### Module Dependencies
8080

81-
Module Dependencies are the modules that a application may depend on and which version of the Cosmos SDK they are compatible with.
81+
Module Dependencies are the modules that an application may depend on and which version of the Cosmos SDK they are compatible with.
8282

8383
> Note: The version table only goes back to 0.50.x, this is due to the reason that modules were not spun out into their own go.mods until 0.50.z. ❌ signals that the module was not spun out into its own go.mod file.
8484

RELEASES.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Releases
22

3-
The Cosmos-SDK follows both [0ver](https://0ver.org/) and [Semver](https://semver.org/). While this is confusing lets break it down: 0ver is used for the main Cosmos-SDK dependency (`github.com/cosmos/cosmos-sdk`) and Semver is used for all other dependencies.
3+
The Cosmos-SDK follows both [0ver](https://0ver.org/) and [Semver](https://semver.org/). While this is confusing let's break it down: 0ver is used for the main Cosmos-SDK dependency (`github.com/cosmos/cosmos-sdk`) and Semver is used for all other dependencies.
44

55
## Semver Dependencies
66

7-
Although we adhere to semantic versioning (semver), we have introduced a few modifications to accommodate the unique characteristics of blockchains. One significant divergence is that the major version (Y.x.x) is incremented solely when a consensus-breaking change occurs. On the other hand, the minor version (x.Y.x) is increased when there is a non-consensus-breaking alteration that also results in an incompatible API change. Patch versions will be bumped for all other changes that dont break the API nor Consensus.
7+
Although we adhere to semantic versioning (semver), we have introduced a few modifications to accommodate the unique characteristics of blockchains. One significant divergence is that the major version (Y.x.x) is incremented solely when a consensus-breaking change occurs. On the other hand, the minor version (x.Y.x) is increased when there is a non-consensus-breaking alteration that also results in an incompatible API change. Patch versions will be bumped for all other changes that don't break the API nor Consensus.
88

99
```mermaid
1010
flowchart TD

RELEASE_PROCESS.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ v1.0.0-beta1 → v1.0.0-beta2 → ... → v1.0.0-rc1 → v1.0.0-rc2 → ... →
2020
* perform functional tests
2121
* add more tests
2222
* release new beta version as the bugs are discovered and fixed.
23-
* After the team feels that the `main` works fine we create a `release/vY` branch (going forward known a release branch), where `Y` is the version number, with the patch part substituted to `x` (eg: 0.42.x, 1.0.x). Ensure the release branch is protected so that pushes against the release branch are permitted only by the release manager or release coordinator.
23+
* After the team feels that the `main` works fine we create a `release/vY` branch (going forward known as release branch), where `Y` is the version number, with the patch part substituted to `x` (eg: 0.42.x, 1.0.x). Ensure the release branch is protected so that pushes against the release branch are permitted only by the release manager or release coordinator.
2424
* **PRs targeting this branch can be merged _only_ when exceptional circumstances arise**
2525
* update the GitHub mergify integration by adding instructions for automatically backporting commits from `main` to the `release/vY` using the `backport/Y` label.
2626
* In the release branch prepare a new version section in the `CHANGELOG.md`
@@ -31,7 +31,7 @@ v1.0.0-beta1 → v1.0.0-beta2 → ... → v1.0.0-rc1 → v1.0.0-rc2 → ... →
3131
* Remove GitHub workflows that should not be in the release branch
3232
* `test.yml`: All standalone go module tests should be removed (expect `./simapp`, and `./tests`, SDK and modules tests).
3333
* These packages are tracked and tested directly on main.
34-
* `build.yml`: Only the SDK and SimApp needs to be built on release branches.
34+
* `build.yml`: Only the SDK and SimApp need to be built on release branches.
3535
* Tooling is tracked and tested directly on main.
3636
* This does not apply for tooling depending on the SDK (e.g. `confix`)
3737
* Update `Dockerfile` to not use latest go.mod and go.sum files.
@@ -66,7 +66,7 @@ After the release branch has all commits required for the next patch release:
6666

6767
* Update `CHANGELOG.md` and `RELEASE_NOTES.md` (if applicable).
6868
* Create a new annotated git tag (eg `git -a v1.1.0`) in the release branch.
69-
* If the release is a submodule update, first go the submodule folder and name the tag prepending the path to the version:
69+
* If the release is a submodule update, first go to the submodule folder and name the tag prepending the path to the version:
7070
`cd core && git -a core/v1.1.0` or `cd tools/cosmovisor && git -a tools/cosmovisor/v1.4.0`
7171
* Create a GitHub release (if applicable).
7272

@@ -138,7 +138,7 @@ See the SDK's policy on migrations [here](https://docs.cosmos.network/main/migra
138138

139139
* State machine changes.
140140
* Breaking changes in Protobuf definitions, as specified in [ADR-044](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-044-protobuf-updates-guidelines.md).
141-
* Changes that introduces API breakages (e.g. public functions and interfaces removal/renaming).
141+
* Changes that introduce API breakages (e.g. public functions and interfaces removal/renaming).
142142
* Client-breaking changes in gRPC and HTTP request and response types.
143143
* CLI-breaking changes.
144144
* Cosmetic fixes, such as formatting or linter warning fixes.
@@ -182,15 +182,15 @@ As rule of thumb, the following changes will **NOT** be automatically accepted i
182182
```md
183183
#### Impact
184184

185-
Brief xplanation of the effects of the bug on users and a justification for backporting the fix to the stable release.
185+
Brief explanation of the effects of the bug on users and a justification for backporting the fix to the stable release.
186186

187187
#### Test Case
188188

189189
Detailed instructions on how to reproduce the bug on Stargate's most recently published point-release.
190190

191191
#### Regression Potential
192192

193-
Explanation on how regressions might manifest - even if it's unlikely.
193+
Explanation of how regressions might manifest - even if it's unlikely.
194194
It is assumed that stable release fixes are well-tested and they come with a low risk of regressions.
195195
It's crucial to make the effort of thinking about what could happen in case a regression emerges.
196196
```

ROADMAP.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Welcome to the Cosmos SDK's team roadmap.
4545
* Migrating 3 modules to use collections would help in show users how to migrate users
4646
* [ ] [Release ORM v1](https://github.com/cosmos/cosmos-sdk/issues/11088)
4747
* [x] [Sign mode textual](https://github.com/cosmos/cosmos-sdk/issues/11970)
48-
* Sign mode textual has been under construction for 2 quarters now, this quarter the goal is to move towards v1 and potentially line up a audit before final release.
48+
* Sign mode textual has been under construction for 2 quarters now, this quarter the goal is to move towards v1 and potentially line up an audit before final release.
4949
* [x] Core API
5050
* [Merge ADR for Core API](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-063-core-module-api.md)
5151
* Migrate three modules to use core api
@@ -66,7 +66,7 @@ Welcome to the Cosmos SDK's team roadmap.
6666
### Testing
6767

6868
* [x] [integration testing framework](https://github.com/cosmos/cosmos-sdk/issues/14145)
69-
* design and merge a integration testing framework.
69+
* design and merge an integration testing framework.
7070
* The goals of the framework would that a module only needs to depend on modules that it depends on outside of testing, not all modules in the sdk like today.
7171

7272

@@ -200,7 +200,7 @@ Issue: https://github.com/cosmos/iavl/issues/548
200200

201201
* [ ] [Invariant Checking](https://github.com/cosmos/cosmos-sdk/issues/15706)
202202
* Objective:
203-
* Design a new system for checking invairants
203+
* Design a new system for checking invariants
204204
* Implement changes
205205
* Audit current invariants
206206
* Progress:

UPGRADING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ Use `confix` to clean-up your `app.toml`. A nginx (or alike) reverse-proxy can b
476476

477477
#### Database Support
478478

479-
ClevelDB, BoltDB and BadgerDB are not supported anymore. To migrate from a unsupported database to a supported database please use a database migration tool.
479+
ClevelDB, BoltDB and BadgerDB are not supported anymore. To migrate from an unsupported database to a supported database please use a database migration tool.
480480

481481
### Protobuf
482482

@@ -1219,7 +1219,7 @@ mistakes.
12191219

12201220
#### `x/params`
12211221

1222-
* The `x/params` module has been deprecated in favour of each module housing and providing way to modify their parameters. Each module that has parameters that are changeable during runtime have an authority, the authority can be a module or user account. The Cosmos SDK team recommends migrating modules away from using the param module. An example of how this could look like can be found [here](https://github.com/cosmos/cosmos-sdk/pull/12363).
1222+
* The `x/params` module has been deprecated in favour of each module housing and providing way to modify their parameters. Each module that has parameters that are changeable during runtime has an authority, the authority can be a module or user account. The Cosmos SDK team recommends migrating modules away from using the param module. An example of how this could look like can be found [here](https://github.com/cosmos/cosmos-sdk/pull/12363).
12231223
* The Param module will be maintained until April 18, 2023. At this point the module will reach end of life and be removed from the Cosmos SDK.
12241224

12251225
#### `x/gov`
@@ -1232,11 +1232,11 @@ More information can be found in the gov module [client documentation](https://d
12321232

12331233
#### `x/staking`
12341234

1235-
The `staking module` added a new message type to cancel unbonding delegations. Users that have unbonded by accident or wish to cancel a undelegation can now specify the amount and valdiator they would like to cancel the unbond from
1235+
The `staking module` added a new message type to cancel unbonding delegations. Users that have unbonded by accident or wish to cancel an undelegation can now specify the amount and validator they would like to cancel the unbond from
12361236

12371237
### Protobuf
12381238

1239-
The `third_party/proto` folder that existed in [previous version](https://github.com/cosmos/cosmos-sdk/tree/v0.45.3/third_party/proto) now does not contains directly the [proto files](https://github.com/cosmos/cosmos-sdk/tree/release/v0.46.x/third_party/proto).
1239+
The `third_party/proto` folder that existed in [previous version](https://github.com/cosmos/cosmos-sdk/tree/v0.45.3/third_party/proto) now does not contain directly the [proto files](https://github.com/cosmos/cosmos-sdk/tree/release/v0.46.x/third_party/proto).
12401240

12411241
Instead, the SDK uses [`buf`](https://buf.build). Clients should have their own [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml) with `buf.build/cosmos/cosmos-sdk` as dependency, in order to avoid having to copy paste these files.
12421242

0 commit comments

Comments
 (0)