Skip to content

Commit f17e580

Browse files
update template
1 parent 1bdf23c commit f17e580

File tree

5 files changed

+23
-60
lines changed

5 files changed

+23
-60
lines changed

.CONTRIBUTING/tutorials/templates/governance-template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Before starting, ensure you have:
2424
- Access to Polkadot.js Apps or governance interface
2525
- [Specific requirements based on tutorial type]
2626

27-
## Step 1: Understanding the Governance System
27+
## Understanding the Governance System
2828

2929
[Explain the specific governance mechanism being used]
3030

@@ -40,7 +40,7 @@ For this tutorial, we'll focus on:
4040
- **Decision Period**: [Timeline information]
4141
- **Required Approval**: [Approval/support thresholds]
4242

43-
## Step 2: [Specific Governance Action Setup]
43+
## [Specific Governance Action Setup]
4444

4545
### For Creating Proposals:
4646
[Steps to create and submit a proposal]
@@ -111,7 +111,7 @@ const delegate = api.tx.convictionVoting.delegate(
111111
!!!tip "Screenshot Guidelines"
112112
Use 1512px width for desktop screenshots. Crop to show only relevant interface elements.
113113

114-
## Step 4: Monitoring and Participation
114+
## Monitoring and Participation
115115

116116
Track the progress of governance actions:
117117

@@ -128,7 +128,7 @@ Track the progress of governance actions:
128128
- **Turnout**: Total voting power participating
129129
- **Time Remaining**: Decision period countdown
130130

131-
## Step 5: Understanding Results and Next Steps
131+
## Understanding Results and Next Steps
132132

133133
Analyze the outcome of your governance participation:
134134

.CONTRIBUTING/tutorials/templates/polkadot-sdk-template.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Before starting, ensure you have:
2424
- Basic understanding of [required concepts]
2525
- [Tokens/accounts if needed]
2626

27-
## Step 1: Project Setup
27+
## Project Setup
2828

2929
[Set up the development environment and project structure]
3030

@@ -41,7 +41,7 @@ Expected output:
4141
[Show expected terminal output]
4242
```
4343

44-
## Step 2: [Main Development Phase]
44+
## [Main Development Phase]
4545

4646
[Core implementation steps - adjust based on tutorial type:]
4747

@@ -55,7 +55,7 @@ Expected output:
5555
- Implement extrinsics
5656
- Add tests
5757

58-
```rust
58+
```rust title="lib.rs"
5959
// Example code with clear comments
6060
#[pallet::storage]
6161
pub type SomeValue<T> = StorageValue<_, u32>;
@@ -64,7 +64,7 @@ pub type SomeValue<T> = StorageValue<_, u32>;
6464
!!!tip
6565
Explain key concepts or provide helpful context here.
6666

67-
## Step 3: Testing and Verification
67+
## Testing and Verification
6868

6969
Test your implementation:
7070

@@ -81,11 +81,6 @@ Verify everything works by:
8181
2. [Specific verification step 2]
8282
3. [Expected behavior/output]
8383

84-
## Step 4: [Advanced Configuration - if applicable]
85-
86-
[Optional advanced steps for intermediate/advanced tutorials]
87-
88-
8984
## Where to Go Next
9085

9186
Continue your Polkadot SDK journey with:

.CONTRIBUTING/tutorials/templates/smart-contracts-template.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,27 @@ categories: Smart Contracts, EVM, PVM, DeFi
1919
Before starting, ensure you have:
2020

2121
- **For EVM/PVM contracts**: Remix IDE or local development setup
22-
- MetaMask wallet configured for [specific network]
22+
- Ethereum-compatible wallet set up for [specific network]
2323
- Test tokens for deployment and testing
2424
- Basic understanding of [Solidity/Rust/relevant language]
2525

26-
## Step 1: Development Environment Setup
26+
## Development Environment Setup
2727

2828
[Set up the appropriate development environment]
2929

3030
### For EVM Contracts:
31+
3132
```bash
3233
# Install required tools
3334
npm install -g @openzeppelin/cli@VERSION
3435
npm install hardhat
3536
```
3637

37-
## Step 2: Contract Design and Structure
38+
## Contract Design and Structure
3839

3940
[Explain the contract architecture and key components]
4041

41-
```solidity
42+
```solidity title="Contract.sol"
4243
// For EVM contracts - example structure
4344
pragma solidity ^0.8.19;
4445
@@ -55,7 +56,7 @@ contract YourContract {
5556
}
5657
}
5758
58-
## Step 3: Contract Implementation
59+
## Contract Implementation
5960
6061
[Step-by-step implementation of core functionality]
6162
@@ -69,7 +70,7 @@ contract YourContract {
6970
!!!warning
7071
Important security considerations specific to this contract type.
7172
72-
## Step 4: Testing
73+
## Testing
7374
7475
Write comprehensive tests:
7576
@@ -90,7 +91,7 @@ Run tests:
9091
npx hardhat test
9192

9293

93-
## Step 5: Deployment
94+
## Deployment
9495

9596
Deploy your contract:
9697

@@ -101,7 +102,7 @@ npx hardhat run scripts/deploy.js --network [testnet-name]
101102
```
102103

103104

104-
## Step 6: Interaction and Verification
105+
## Interaction and Verification
105106

106107
Test contract functionality:
107108

@@ -114,16 +115,6 @@ Test contract functionality:
114115

115116
![Contract interaction screenshot](/images/tutorials/smart-contracts/[category]/[tutorial-name]/contract-interaction.webp)
116117

117-
## Advanced Features [Optional]
118-
119-
[For intermediate/advanced tutorials - additional features like:]
120-
- Integration with oracles
121-
- Advanced token mechanics
122-
- Cross-contract calls
123-
- Upgradeable patterns
124-
125-
126-
127118
## Where to Go Next
128119

129120
Extend your smart contract skills:

.CONTRIBUTING/tutorials/templates/xcm-interoperability-template.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Before starting, ensure you have:
2525
- Basic understanding of XCM concepts
2626
- Access to testnet networks (if applicable)
2727

28-
## Step 1: Chopsticks Environment Setup
28+
## Chopsticks Environment Setup
2929

3030
First, we'll set up Chopsticks to simulate the network environment for XCM testing.
3131

@@ -53,7 +53,7 @@ const networks = {
5353
2. Fund accounts with necessary tokens
5454
3. Verify account balances
5555

56-
## Step 2: Understanding the Cross-Chain Flow
56+
## Understanding the Cross-Chain Flow
5757

5858
[Explain the specific XCM operation being performed]
5959

@@ -76,7 +76,7 @@ let xcm = Xcm(vec![
7676
2. **Relay Chain**: [How the relay chain processes the message]
7777
3. **Destination Chain**: [What happens on the destination chain]
7878

79-
## Step 3: [Specific XCM Operation - e.g., Asset Transfer]
79+
## [Specific XCM Operation - e.g., Asset Transfer]
8080

8181
[Detailed steps for the specific cross-chain operation]
8282

@@ -99,12 +99,7 @@ const transfer = api.tx.xcmPallet.limitedReserveTransferAssets(
9999
);
100100
```
101101

102-
![XCM transaction setup](/images/tutorials/interoperability/[category]/[tutorial-name]/xcm-setup.webp)
103-
104-
!!!tip "Screenshot Dimensions"
105-
Desktop screenshots: 1512px width, variable height. Browser extensions: 400x600px.
106-
107-
## Step 4: Execution and Monitoring
102+
## Execution and Monitoring
108103

109104
Execute the cross-chain operation:
110105

@@ -120,7 +115,7 @@ Execute the cross-chain operation:
120115
cargo run -- monitor-xcm --transaction-hash [hash]
121116
```
122117

123-
## Step 5: Verification
118+
## Verification
124119

125120
Verify the successful cross-chain operation:
126121

@@ -134,24 +129,6 @@ Expected results:
134129
- Destination chain balance: [Expected change]
135130
- XCM execution status: Success
136131

137-
## Testing with XCM Simulator [Optional]
138-
139-
For development and testing:
140-
141-
```rust
142-
// XCM Simulator test setup
143-
use xcm_simulator::*;
144-
145-
#[test]
146-
fn test_cross_chain_transfer() {
147-
// Test implementation
148-
}
149-
```
150-
151-
## Advanced XCM Patterns [For Advanced Tutorials]
152-
153-
[Include for intermediate/advanced tutorials:]
154-
155132
### Multi-hop XCM
156133
- Routing through multiple chains
157134
- Complex asset transformations

tutorials/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ Ready to contribute a tutorial? Get started here:
2121
- **dapps/** - Frontend integration, API usage
2222
- **onchain-governance/** - Proposals, OpenGov operations
2323

24-
Start with working code, clear steps, and we'll help you polish the rest!
24+
Start with working code, clear steps, and the team will help you polish the rest!

0 commit comments

Comments
 (0)