From ac01b4e5d040d0f3efeb3effd2cff0fe2f8070bf Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Tue, 28 Jan 2025 11:48:01 +0200 Subject: [PATCH] Docs fix spelling issues (#2381) --- ARCHITECTURE.md | 6 +++--- RELEASES_CHECKLIST.md | 2 +- SECURITY.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 10afd22c13..158bc8176b 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -46,9 +46,9 @@ ink! is composed of a number of crates that are all found in the * [`e2e`](https://github.com/use-ink/ink/tree/master/crates/e2e): An end-to-end testing framework for ink! contracts. It requires a Substrate node which includes `pallet-revive` running in the background. The crate provides a - macro which can be used + macro that can be used to write an idiomatic Rust test that will in the background create transactions, - submit it to the Substrate chain and return the state changes, gas costs, etc. + submit them to the Substrate chain and return the state changes, gas costs, etc. An important thing to note is that the crates are primarily run in a `no_std` environment. @@ -186,7 +186,7 @@ each new released iteration of the function there is a new version of it introdu In the example above you can see that we changed the function `set_storage` at one point. -The prefix `seal` here is for historic reasons. There is some analogy to sealing a +The prefix `seal` here is for historical reasons. There is some analogy to sealing a contract. And we found seals to be a cute animal as well ‒ like squids! ## `Environment` Trait diff --git a/RELEASES_CHECKLIST.md b/RELEASES_CHECKLIST.md index b469f54d11..20725c0f0f 100644 --- a/RELEASES_CHECKLIST.md +++ b/RELEASES_CHECKLIST.md @@ -81,7 +81,7 @@ in the future. branch. - Notify core team members in the Element channel that no PRs should be merged to `master` during the release. - - The above are to ensure that the bundled code pushed to crates.io is the same as + - The above is to ensure that the bundled code pushed to crates.io is the same as the tagged release on GitHub. 5. Publish with `cargo release [new_version] -v --no-tag --no-push --execute` - Ensure the same `[new_version]` as the dry run, which should be the **exact** SemVer diff --git a/SECURITY.md b/SECURITY.md index e77ee0d7e9..b68b57ace6 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,5 +1,5 @@ # Reporting a vulnerability -If you find something that can be treated as a security vulnerability, please do not use the issue tracker or discuss it in the public forum/channels, as it can cause more damage rather than giving real help to the ecosystem. +If you find something that can be treated as a security vulnerability, please do not use the issue tracker or discuss it in the public forum/channels, as it can cause more damage rather than give real help to the ecosystem. Security vulnerabilities should be reported using [this contact form](https://blocksurvey.io/ink-security-vulnerability-reporting-QCfzqPF8QMqIrJUEll7yPA?v=o).