Pallet Name Customisation (#4806)

Added Instructions for pallet name customisation in the ReadMe --------- Signed-off-by: Oliver Tale-Yazdi <[email protected]> Co-authored-by: Oliver Tale-Yazdi <[email protected]> Co-authored-by: Bastian Köcher <[email protected]>
paritytech · Jul 1, 2024 · 18ed309 · 18ed309
1 parent 18228a9
commit 18ed309
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/templates/minimal/README.md b/templates/minimal/README.md
@@ -37,6 +37,21 @@ A Polkadot SDK based project such as this one consists of:
 * 🛠️ Depending on your operating system and Rust version, there might be additional
 packages required to compile this template - please take note of the Rust compiler output.
 
+## Customization
+
+In case you would like to change the pallet's name from  `pallet-minimal-template` to `pallet-test`, 
+you would need to implement the following changes:
+* Change the pallet folder name from `template` to `test` for consistency
+* Also for consistency, in `/runtime/src/lib.rs`, change from `pub type Template` to `pub type Test`, 
+and don't forget to also customize the corresponding comments.
+* Change  `pallet-minimal-template` to `pallet-test` in the following files:
+    * `/runtime/Cargo.toml`
+    * `/runtime/src/lib.rs`
+    * `/pallets/test/Cargo.toml`
+    * `/src/lib.rs`
+* Change `pallet_minimal_template` to `pallet_test` in the following files:
+    * `/runtime/src/lib.rs`
+
 ### Build
 
 🔨 Use the following command to build the node without launching it: