add codespell workflow (#1021)

* add codespell

* fix typo

* fix typo

Author: zjb0807

.codespell/codespellrc

@@ -0,0 +1,5 @@
+[codespell]
+skip = .git,Cargo.lock
+count =
+quiet-level = 3
+ignore-words = ./.codespell/ignore.txt

.codespell/ignore.txt

@@ -0,0 +1 @@
+codespell==2.4.1

.codespell/requirements.txt

@@ -0,0 +1,33 @@
+# A Github action that using codespell to check spelling.
+# see .codespell/* for configs
+# https://github.com/codespell-project/codespell
+
+name: codespell
+
+on:
+  # Triggers the workflow on push or pull request against main
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install codespell requirements
+        run: pip install -r ./.codespell/requirements.txt
+
+      - name: Spell check
+        run: codespell --config=./.codespell/codespellrc

.github/workflows/codespell.yml

@@ -2,10 +2,10 @@
 
 ### Overview
 
-Authority module to provide features for governance including dispatch method on behalf other accounts and schdule dispatchables.
+Authority module to provide features for governance including dispatch method on behalf other accounts and schedule dispatchables.
 
 - `dispatch_as` can dispatch a dispatchable on behalf of other origin.
-- `schedule_dispatch` can schdule a dispatchable to be dispatched at later block.
+- `schedule_dispatch` can schedule a dispatchable to be dispatched at later block.
 - `fast_track_scheduled_dispatch` can fast track a scheduled dispatchable.
 - `delay_scheduled_dispatch` can delay a scheduled dispatchable.
 - `cancel_scheduled_dispatch` can cancel a scheduled dispatchable.

authority/README.md

@@ -1172,7 +1172,7 @@ macro_rules! impl_benchmark_test_suite {
 									$crate::BenchmarkError::Override(_) => {
 										// This is still considered a success condition.
 										$crate::log::error!(
-											"WARNING: benchmark error overrided - {}",
+											"WARNING: benchmark error overridden - {}",
 											$crate::str::from_utf8(benchmark_name)
 												.expect("benchmark name is always a valid string!"),
 										);
@@ -1300,7 +1300,7 @@ macro_rules! add_benchmark {
 				Err($crate::BenchmarkError::Override(mut result)) => {
 					// Insert override warning as the first storage key.
 					$crate::log::error!(
-						"WARNING: benchmark error overrided - {}",
+						"WARNING: benchmark error overridden - {}",
 						$crate::str::from_utf8(benchmark)
 							.expect("benchmark name is always a valid string!")
 					);

benchmarking/src/lib.rs

@@ -5,4 +5,4 @@
 This module exposes capabilities for oracle operators to feed external offchain data.
 The raw values can be combined to provide an aggregated value.
 
-The data is valid only if feeded by an authorized operator. This module implements `frame_support::traits::InitializeMembers` and `frame_support::traits::ChangeMembers`, to provide a way to manage operators membership. Typically it could be leveraged to `pallet_membership` in FRAME.
+The data is valid only if fed by an authorized operator. This module implements `frame_support::traits::InitializeMembers` and `frame_support::traits::ChangeMembers`, to provide a way to manage operators membership. Typically it could be leveraged to `pallet_membership` in FRAME.

oracle/README.md

@@ -11,7 +11,7 @@
 //! offchain data. The raw values can be combined to provide an aggregated
 //! value.
 //!
-//! The data is valid only if feeded by an authorized operator.
+//! The data is valid only if fed by an authorized operator.
 //! `pallet_membership` in FRAME can be used to as source of `T::Members`.
 
 #![cfg_attr(not(feature = "std"), no_std)]
@@ -130,7 +130,7 @@ pub mod module {
 	pub enum Error<T, I = ()> {
 		/// Sender does not have permission
 		NoPermission,
-		/// Feeder has already feeded at this block
+		/// Feeder has already fed at this block
 		AlreadyFeeded,
 	}
 

oracle/src/lib.rs

@@ -29,7 +29,7 @@ This pallet allows users to create secure reversible payments that keep funds lo
 
 - `pay` - Create an payment for the given currencyid/amount
 - `pay_with_remark` - Create a payment with a remark, can be used to tag payments
-- `release` - Release the payment amount to recipent
+- `release` - Release the payment amount to recipient
 - `cancel` - Allows the recipient to cancel the payment and release the payment amount to creator
 - `resolve_release_payment` - Allows assigned judge to release a payment
 - `resolve_cancel_payment` - Allows assigned judge to cancel a payment

payments/README.md

@@ -30,7 +30,7 @@
 //! - `pay` - Create an payment for the given currencyid/amount
 //! - `pay_with_remark` - Create a payment with a remark, can be used to tag
 //!   payments
-//! - `release` - Release the payment amount to recipent
+//! - `release` - Release the payment amount to recipient
 //! - `cancel` - Allows the recipient to cancel the payment and release the
 //!   payment amount to creator
 //! - `resolve_release_payment` - Allows assigned judge to release a payment
@@ -207,13 +207,13 @@ pub mod pallet {
 		InvalidAction,
 		/// Payment is in review state and cannot be modified
 		PaymentNeedsReview,
-		/// Unexpeted math error
+		/// Unexpected math error
 		MathError,
 		/// Payment request has not been created
 		RefundNotRequested,
 		/// Dispute period has not passed
 		DisputePeriodNotPassed,
-		/// The automatic cancelation queue cannot accept
+		/// The automatic cancellation queue cannot accept
 		RefundQueueFull,
 	}
 
@@ -400,7 +400,7 @@ pub mod pallet {
 		}
 
 		/// Allow the creator of a payment to initiate a refund that will return
-		/// the funds after a configured amount of time that the reveiver has to
+		/// the funds after a configured amount of time that the receiver has to
 		/// react and oppose the request
 		#[pallet::call_index(4)]
 		#[pallet::weight(T::WeightInfo::request_refund())]