Merge pull request #61 from polkadot-developers/refactor/improvements

refactor: parachain template and PAPI improvements

Author: brunopgalvao

.github/workflows/test-sdk.yml

@@ -295,15 +295,15 @@ jobs:
         if: needs.check-changes.outputs.sdk_changed == 'true'
         run: cargo build --package cli --locked --verbose
 
-      - name: Test CLI - Valid recipe creation
+      - name: Test CLI - Valid project creation
         if: needs.check-changes.outputs.sdk_changed == 'true'
         run: |
           cargo run --package cli --locked -- create --title "Testing CLI Validation" --skip-install --no-git --non-interactive
-          if [ ! -f "recipes/pallets/testing-cli-validation/README.md" ]; then
+          if [ ! -f "testing-cli-validation/README.md" ]; then
             echo "Error: Project was not created"
             exit 1
           fi
-          rm -rf recipes/pallets/testing-cli-validation
+          rm -rf testing-cli-validation
 
       - name: Test CLI - Missing required title
         if: needs.check-changes.outputs.sdk_changed == 'true'

CONTRIBUTING.md

@@ -74,8 +74,18 @@ Edit the generated files:
 ### 4. Test Your Project
 
 ```bash
-# Test your project
+# Test from within the project directory
+cd my-project-name
+dot test
+
+# Or specify the project path
 dot test my-project-name
+
+# Run only Rust tests
+dot test --rust
+
+# Run only TypeScript tests
+dot test --ts
 ```
 
 ### 5. Submit as a Recipe
@@ -130,7 +140,10 @@ dot contract        # Create a contract project
 dot parachain       # Create a parachain project
 
 # Testing and submission
-dot test            # Test a project
+dot test            # Test current directory project
+dot test <path>     # Test specific project
+dot test --rust     # Run only Rust tests
+dot test --ts       # Run only TypeScript tests
 dot submit          # Submit as pull request to cookbook
 ```
 

README.md

@@ -202,7 +202,10 @@ curl -fsSL https://raw.githubusercontent.com/polkadot-developers/polkadot-cookbo
 # Create a new project (interactive mode)
 dot create
 
-# Test your project
+# Test your project (from within project directory)
+dot test
+
+# Or specify a path
 dot test my-pallet
 
 # Submit your project as a recipe to the cookbook

docs/developers/cli-reference.md

@@ -89,9 +89,9 @@ dot create \
 
 **What it Creates:**
 
-**Parachain Recipe:**
+**Parachain Project:**
 ```
-recipes/my-parachain/
+my-parachain/
 ├── README.md              # Tutorial documentation
 ├── Cargo.toml             # Workspace configuration
 ├── rust-toolchain.toml    # Rust version specification
@@ -101,22 +101,24 @@ recipes/my-parachain/
 ├── runtime/               # Parachain runtime
 ├── tests/                 # PAPI integration tests
 ├── scripts/               # Node management scripts
-└── zombienet-xcm.toml     # Multi-parachain XCM testing
+├── dev_chain_spec.json    # Development chain specification
+├── zombienet.toml         # Parachain node network config
+└── zombienet-omni-node.toml  # Omni-node network config
 ```
 
-**Pallet-Only Recipe:**
+**Pallet-Only Project:**
 ```
-recipes/my-pallet/
+my-pallet/
 ├── README.md              # Pallet documentation
 ├── Cargo.toml             # Minimal workspace
 ├── rust-toolchain.toml    # Rust version
 └── pallets/               # Custom pallet only
     └── template/          # Template pallet with mock runtime
 ```
 
-**Contracts Recipe:**
+**Contracts Project:**
 ```
-recipes/my-contract/
+my-contract/
 ├── README.md              # Contract documentation
 ├── package.json           # Hardhat dependencies
 ├── hardhat.config.ts      # Hardhat configuration
@@ -182,33 +184,46 @@ git config --global user.email "[email protected]"
 
 ### `test`
 
-Run tests for a recipe.
+Run tests for a project.
 
 **Usage:**
 ```bash
-dot test <SLUG>
+dot test [PATH] [OPTIONS]
 ```
 
 **Arguments:**
-- `SLUG` - Recipe slug to test
+- `PATH` - Project path to test (defaults to current directory)
+
+**Options:**
+- `--rust` - Run only Rust tests (cargo test)
+- `--ts` - Run only TypeScript tests (npm test)
 
 **What it Does:**
-1. Detects recipe type (Rust, TypeScript, etc.)
-2. Runs appropriate test command
-3. Reports results
+1. Detects project type from `Cargo.toml` and/or `package.json`
+2. By default, runs both test suites if project has both
+3. Reports results for each test suite
 
 **Examples:**
 ```bash
-# Test specific recipe
-dot test basic-pallet
+# Test current directory (runs both Rust and TS tests if applicable)
+dot test
+
+# Test specific project path
+dot test my-parachain
+
+# Run only Rust tests
+dot test --rust
+
+# Run only TypeScript tests
+dot test --ts
 
-# Test current directory recipe
-dot test .
+# Combine path and flags
+dot test my-parachain --rust
 ```
 
 **Exit Codes:**
-- `0` - Tests passed
-- `1` - Tests failed
+- `0` - All tests passed
+- `1` - One or more tests failed
 
 ---