Skip to content

Commit 077f0e1

Browse files
update tutorial contributing
1 parent 9d8427a commit 077f0e1

File tree

4 files changed

+92
-31
lines changed

4 files changed

+92
-31
lines changed

.CONTRIBUTING/.CONTRIBUTING.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -238,27 +238,15 @@ In general, titles should be between 50 and 60 characters and descriptions shoul
238238

239239
## Contributing Tutorials
240240

241-
For step-by-step tutorials, we have a specialized workflow and dedicated guides. Start with the [**tutorials overview**](tutorials/README.md) to see all available options, or jump directly to:
242-
243-
### Quick Tutorial Contributing
244-
- **[Quick Guide](tutorials/QUICK_GUIDE.md)** - Essential requirements for experienced contributors
245-
- Focus on working code and clear instructions
246-
- Everything else is optional and can be refined during review
247-
248-
### Detailed Tutorial Guidelines
249-
- **[Style Guide](tutorials/STYLE_GUIDE.md)** - Comprehensive guide with detailed formatting rules
250-
- **[Templates](tutorials/templates/)** - Ready-to-use templates for different tutorial categories:
251-
- Polkadot SDK tutorials
252-
- Smart contracts tutorials
253-
- XCM/Interoperability tutorials
254-
- dApps tutorials
255-
- Governance tutorials
256-
257-
### Tutorial Categories
258-
- **polkadot-sdk/**: Parachains, pallets, runtime development
259-
- **smart-contracts/**: EVM contracts, ink! contracts, demo applications
260-
- **interoperability/**: XCM operations, cross-chain workflows
261-
- **dapps/**: Frontend development, API integrations
262-
- **onchain-governance/**: Proposals, voting, delegation
241+
For step-by-step tutorials, we have a specialized workflow and dedicated guides:
242+
243+
**[Tutorial Contributing Guide](tutorials/.CONTRIBUTING.md)**
244+
245+
This includes:
246+
247+
- **Requirements** - Essential metadata and file structure
248+
- **Categories** - SDK, smart contracts, XCM, dApps, governance
249+
- **Templates** - Ready-to-use templates for different tutorial types
250+
- **Guidelines** - Code standards, testing, and submission process
263251

264252
Tutorials follow a different structure than general documentation and have specific requirements for metadata, file organization, and navigation updates.
Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
1-
# Contributing Tutorials - Quick Guide
1+
# Contributing Tutorials
22

3-
Fast-track guide for experienced contributors. For detailed explanations, see [STYLE_GUIDE.md](STYLE_GUIDE.md).
3+
## Choose Your Contributing Path
4+
5+
### Team-Assisted Path (Recommended)
6+
**Allow the team to handle formatting and style**
7+
8+
**Benefits:**
9+
- Faster review process
10+
- Fewer style-related review comments
11+
- Team handles technical formatting requirements
12+
13+
**Your responsibility:**
14+
- Working code and clear instructions
15+
- Following essential requirements below
16+
17+
**Important:** Enable "Allow edits by maintainers" on your PR
18+
19+
**Recommendation:** Even with team assistance, reviewing the [STYLE_GUIDE.md](STYLE_GUIDE.md) helps you create better tutorials from the start.
20+
21+
### Self-Managed Path
22+
**Handle all formatting and style requirements yourself**
23+
24+
**Full control** over your tutorial format and style
25+
**More review rounds** - you must fix all style issues
26+
**Required reading:** [STYLE_GUIDE.md](STYLE_GUIDE.md)
27+
28+
---
29+
30+
# Team-Assisted Path: Essential Requirements
431

532
## Essential Requirements
633

@@ -82,12 +109,28 @@ images/tutorials/[category]/[subcategory]/[tutorial-name]/
82109
- [ ] Files follow naming conventions
83110
- [ ] Verification steps included
84111

85-
## Quick Links
112+
---
86113

87-
- **Templates**: [templates/](templates/) folder
88-
- **Style Guide**: [STYLE_GUIDE.md](STYLE_GUIDE.md)
89-
- **Examples**: Browse existing tutorials for reference
114+
# Self-Managed Path: Complete Requirements
115+
116+
If you choose the self-managed path, you must follow **all** requirements in [STYLE_GUIDE.md](STYLE_GUIDE.md), including:
117+
118+
- Complete metadata specifications
119+
- Image optimization and formatting
120+
- Navigation file updates (.nav.yml)
121+
- Advanced style and formatting rules
122+
- SEO optimization requirements
123+
124+
**Note:** All style-related review comments must be addressed by you.
90125

91126
---
92127

93-
Need help? Check the [detailed style guide](STYLE_GUIDE.md) or existing tutorials for examples.
128+
## Resources
129+
130+
- **Templates**: [templates/](templates/) folder - Ready-to-use templates for different tutorial categories
131+
- **Style Guide**: [STYLE_GUIDE.md](STYLE_GUIDE.md) - Complete formatting requirements (recommended for all, required for self-managed)
132+
- **Examples**: Browse existing tutorials for reference
133+
134+
**Questions?** The team is here to help regardless of which path you choose!
135+
136+
---

.CONTRIBUTING/tutorials/STYLE_GUIDE.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Tutorial Style Guide - Detailed Reference
22

3-
Comprehensive guide for tutorial writing standards, formatting, and best practices. For quick reference, see [QUICK_GUIDE.md](QUICK_GUIDE.md).
3+
Comprehensive guide for tutorial writing standards, formatting, and best practices.
4+
5+
**For contributors using the Self-Managed Path:** This guide contains all requirements you must follow.
6+
7+
**For contributors using the Team-Assisted Path:** This guide is recommended reading to create better tutorials from the start, but the team will handle most formatting requirements for you.
8+
9+
Quick reference available at: [TUTORIALS_CONTRIBUTING.md](.CONTRIBUTING.md)
410

511
This guide covers tutorial-specific requirements and formatting. For general writing guidelines that apply to all documentation, refer to the [PaperMoon Documentation Style Guide](https://github.com/papermoonio/documentation-style-guide).
612

@@ -385,6 +391,6 @@ Before submission:
385391

386392
For additional help:
387393
1. Check existing tutorials for examples
388-
2. Review the [quick contributing guide](QUICK_GUIDE.md)
394+
2. Review the [main contributing guide](.CONTRIBUTING.md)
389395
3. Open an issue for clarification
390396
4. Join the Polkadot developer community discussions

tutorials/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing Tutorials
2+
3+
## Quick Start
4+
5+
Ready to contribute a tutorial? Get started here:
6+
7+
👉 **[Tutorial Contributing Guide](../.CONTRIBUTING/tutorials/.CONTRIBUTING.md)**
8+
9+
## What You'll Find
10+
11+
- **Requirements** - Essential metadata and file structure
12+
- **Categories** - Where your tutorial belongs (SDK, smart contracts, XCM, etc.)
13+
- **Templates** - Ready-to-use templates for different tutorial types
14+
- **Guidelines** - Code standards, testing, and submission process
15+
16+
## Tutorial Categories
17+
18+
- **polkadot-sdk/** - Parachains, pallets, runtime development
19+
- **smart-contracts/** - EVM, ink!, demo applications
20+
- **interoperability/** - XCM operations, cross-chain workflows
21+
- **dapps/** - Frontend integration, API usage
22+
- **onchain-governance/** - Proposals, OpenGov operations
23+
24+
Start with working code, clear steps, and we'll help you polish the rest!

0 commit comments

Comments
 (0)