Skip to content

Commit 64ece0b

Browse files
beihailiclaude
andcommitted
docs: add lesson template and quick-start contribution guide
- Add zh/TEMPLATE.md as a starter scaffold for new lesson authors - Add "Your First Contribution in 5 Minutes" section to CONTRIBUTING.md to lower the barrier for first-time contributors Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 5dab2e6 commit 64ece0b

2 files changed

Lines changed: 47 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22
33
# 贡献指南
44

5+
## Your First Contribution in 5 Minutes
6+
7+
1. **Fork** this repository
8+
2. **Find an issue** labeled `good first issue` in [Issues](https://github.com/beihaili/Get-Started-with-Web3/issues)
9+
3. **Clone** your fork: `git clone https://github.com/YOUR_USERNAME/Get-Started-with-Web3.git`
10+
4. **Create a branch**: `git checkout -b fix/your-change`
11+
5. **Make your change** (fix a typo, improve a translation, add a quiz question)
12+
6. **Commit**: `git commit -m "fix: describe your change"`
13+
7. **Push and open a PR**: `git push origin fix/your-change`
14+
15+
Not sure where to start? Translation proofreading is the easiest way to contribute — just find a file in `en/` and improve the English!
16+
517
感谢你对 **Get Started with Web3** 项目的关注!我们欢迎所有形式的贡献。
618

719
## 如何参与

zh/TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# [Lesson Title]
2+
3+
![status](https://img.shields.io/badge/Status-Draft-yellow)
4+
![author](https://img.shields.io/badge/Author-YourName-blue)
5+
6+
## Overview
7+
8+
[1-2 sentence summary of what this lesson covers]
9+
10+
## Prerequisites
11+
12+
- [What the reader should know before this lesson]
13+
14+
## Content
15+
16+
[Main lesson content]
17+
18+
### Section 1
19+
20+
[Content with code examples, diagrams, etc.]
21+
22+
### Section 2
23+
24+
[More content]
25+
26+
## Summary
27+
28+
- [Key takeaway 1]
29+
- [Key takeaway 2]
30+
- [Key takeaway 3]
31+
32+
## Further Reading
33+
34+
- [Resource 1](https://example.com)
35+
- [Resource 2](https://example.com)

0 commit comments

Comments
 (0)