Merge pull request #689 from axone-protocol/ci/codespell

Ci/codespell
axone-protocol · Jan 1, 2025 · c23ea6d · c23ea6d
2 parents b11e4e9 + 402bd41
commit c23ea6d
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 10 deletions.
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,5 @@
+[codespell]
+skip = *.json,*.ttl,CHANGELOG.md,./docs,./target
+count = true
+quiet-level = 3
+ignore-words-list = crate,ser
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -4,10 +4,10 @@ on:
   workflow_call:
 
   push:
-    branches: [ main ]
+    branches: [main]
 
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 concurrency:
   group: lint-${{ github.ref }}
@@ -377,6 +377,20 @@ jobs:
           echo "Please generate docs using \`cargo make docs-generate\` then commit this new documentation."
           exit 1
 
+  lint-typos:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install codespell
+        run: |
+          pip install codespell==2.3.0
+      - name: Check for spelling errors
+        run: |
+          codespell --config .codespellrc
+          exit $?
+
   lint-branch-name:
     runs-on: ubuntu-22.04
     if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request' && (github.event.action == 'opened' || github.event.action == 'reopened')

diff --git a/contracts/axone-cognitarium/README.md b/contracts/axone-cognitarium/README.md
@@ -246,7 +246,7 @@ axoned query wasm contract-state smart $CONTRACT_ADDR \
     '{"select":{"query":{"prefixes":[],"select":[{"variable":"subject"},{"variable":"predicate"},{"variable":"object"}],"where":[{"simple":{"triple_pattern":{"subject":{"variable":"subject"},"predicate":{"variable":"predicate"},"object":{"variable":"object"}}}}],"limit":null}}}'
 ```
 
-Now, let's try something more interresting. Let's retrieve the names of people and their job titles, but only for those who know at least one other person in the network. This query introduces filtering based on relationships.
+Now, let's try something more interesting. Let's retrieve the names of people and their job titles, but only for those who know at least one other person in the network. This query introduces filtering based on relationships.
 
 Here's the query:
 

diff --git a/contracts/axone-dataverse/README.md b/contracts/axone-dataverse/README.md
@@ -35,7 +35,7 @@ DIDs play a crucial role in the Dataverse by facilitating a trustable and intero
 
 Claims in the Dataverse context are assertions or statements made about a Resource identified by a DID.
 
-Claims play a pivotal role in the governance framework of the Dataverse. By leveraging knowledge derived from verifiable credentials, the governances established by Zones can evaluate the fulfilment of specific rules and compliance. This evaluation is critical in ensuring that the resources within the Dataverse adhere to the established norms, policies, and requirements.
+Claims play a pivotal role in the governance framework of the Dataverse. By leveraging knowledge derived from verifiable credentials, the governances established by Zones can evaluate the fulfillment of specific rules and compliance. This evaluation is critical in ensuring that the resources within the Dataverse adhere to the established norms, policies, and requirements.
 
 Claims are submitted in the form of [Verifiable Presentations (VPs)](https://www.w3.org/TR/vc-data-model/#presentations), which are aggregations of one or more [Verifiable Credentials (VCs)](https://www.w3.org/TR/vc-data-model/#what-is-a-verifiable-credential).
 

diff --git a/contracts/axone-dataverse/src/msg.rs b/contracts/axone-dataverse/src/msg.rs
@@ -71,7 +71,7 @@ pub enum ExecuteMsg {
     ///
     /// #### Preconditions:
     ///
-    ///  1. **Identifier Existance**: The identifier of the claims must exist in the dataverse.
+    ///  1. **Identifier Existence**: The identifier of the claims must exist in the dataverse.
     RevokeClaims {
         /// The unique identifier of the claims to be revoked.
         identifier: Uri,

diff --git a/docs/axone-cognitarium.md b/docs/axone-cognitarium.md
@@ -246,7 +246,7 @@ axoned query wasm contract-state smart $CONTRACT_ADDR \
     '{"select":{"query":{"prefixes":[],"select":[{"variable":"subject"},{"variable":"predicate"},{"variable":"object"}],"where":[{"simple":{"triple_pattern":{"subject":{"variable":"subject"},"predicate":{"variable":"predicate"},"object":{"variable":"object"}}}}],"limit":null}}}'
 ```
 
-Now, let's try something more interresting. Let's retrieve the names of people and their job titles, but only for those who know at least one other person in the network. This query introduces filtering based on relationships.
+Now, let's try something more interesting. Let's retrieve the names of people and their job titles, but only for those who know at least one other person in the network. This query introduces filtering based on relationships.
 
 Here's the query:
 
@@ -925,4 +925,4 @@ A named node constant.
 
 ---
 
-_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-cognitarium.json` (`330cdbb56c7cee44`)_
+_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-cognitarium.json` (`cf0ad05cfbb0958c`)_
diff --git a/docs/axone-dataverse.md b/docs/axone-dataverse.md
@@ -35,7 +35,7 @@ DIDs play a crucial role in the Dataverse by facilitating a trustable and intero
 
 Claims in the Dataverse context are assertions or statements made about a Resource identified by a DID.
 
-Claims play a pivotal role in the governance framework of the Dataverse. By leveraging knowledge derived from verifiable credentials, the governances established by Zones can evaluate the fulfilment of specific rules and compliance. This evaluation is critical in ensuring that the resources within the Dataverse adhere to the established norms, policies, and requirements.
+Claims play a pivotal role in the governance framework of the Dataverse. By leveraging knowledge derived from verifiable credentials, the governances established by Zones can evaluate the fulfillment of specific rules and compliance. This evaluation is critical in ensuring that the resources within the Dataverse adhere to the established norms, policies, and requirements.
 
 Claims are submitted in the form of [Verifiable Presentations (VPs)](https://www.w3.org/TR/vc-data-model/#presentations), which are aggregations of one or more [Verifiable Credentials (VCs)](https://www.w3.org/TR/vc-data-model/#what-is-a-verifiable-credential).
 
@@ -108,7 +108,7 @@ Revoke or withdraw a previously submitted claims.
 
 #### Preconditions:
 
-1. **Identifier Existance**: The identifier of the claims must exist in the dataverse.
+1. **Identifier Existence**: The identifier of the claims must exist in the dataverse.
 
 | parameter                  | description                                                                   |
 | -------------------------- | ----------------------------------------------------------------------------- |
@@ -238,5 +238,5 @@ let b = Uint64::from(70u32); assert_eq!(b.u64(), 70); ```
 
 ---
 
-*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-dataverse.json` (`fc11528d7cda380f`)*
+*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-dataverse.json` (`e3b26772811bfe51`)*
 ````