Skip to content

Commit 9891337

Browse files
authored
Merge pull request #24 from Deepak8858/docs/translate-contributing-to-english
docs: translate CONTRIBUTING.md to English
2 parents 4de9047 + 6070787 commit 9891337

2 files changed

Lines changed: 139 additions & 0 deletions

File tree

CONTRIBUTING.en.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
> **README:** [English](README.md) | [中文](README.zh.md)
2+
> **CONTRIBUTING:** [English](CONTRIBUTING.en.md) | [中文](CONTRIBUTING.md)
3+
4+
# Contributing Guide
5+
6+
## Your First Contribution in 5 Minutes
7+
8+
1. **Fork** this repository
9+
2. **Find an issue** labeled `good first issue` in [Issues](https://github.com/beihaili/Get-Started-with-Web3/issues)
10+
3. **Clone** your fork: `git clone https://github.com/YOUR_USERNAME/Get-Started-with-Web3.git`
11+
4. **Create a branch**: `git checkout -b fix/your-change`
12+
5. **Make your change** (fix a typo, improve a translation, add a quiz question)
13+
6. **Commit**: `git commit -m "fix: describe your change"`
14+
7. **Push and open a PR**: `git push origin fix/your-change`
15+
16+
Not sure where to start? Translation proofreading is the easiest way to contribute — just find a file in `en/` and improve the English!
17+
18+
Thank you for your interest in the **Get Started with Web3** project! We welcome all forms of contributions.
19+
20+
## How to Participate
21+
22+
### Reporting Issues
23+
24+
If you find a bug or have a suggestion for improvement, please submit it in [GitHub Issues](https://github.com/beihaili/Get-Started-with-Web3/issues):
25+
26+
1. Search for existing issues to avoid duplicates.
27+
2. Use the appropriate issue template (Bug Report / Feature Request).
28+
3. Provide as much detail as possible, including reproduction steps and screenshots.
29+
30+
### Submitting Code
31+
32+
1. Fork this repository.
33+
2. Create a feature branch: `git checkout -b feat/your-feature`.
34+
3. Commit your changes (follow the commit convention).
35+
4. Push to your fork: `git push origin feat/your-feature`.
36+
5. Create a Pull Request.
37+
38+
### Improving Documentation
39+
40+
- Correct errors or outdated information in tutorials.
41+
- Supplement code examples and explanations.
42+
- Improve the clarity and accuracy of the writing.
43+
44+
### Translation
45+
46+
- We are currently translating from Chinese to English (`en/` directory).
47+
- Feel free to translate existing tutorials or proofread existing translations.
48+
49+
## Development Environment Setup
50+
51+
```bash
52+
# Clone the repository
53+
git clone https://github.com/beihaili/Get-Started-with-Web3.git
54+
cd Get-Started-with-Web3
55+
56+
# Install dependencies
57+
npm install
58+
59+
# Start the development server
60+
npm run dev
61+
62+
# Run tests
63+
npm test
64+
65+
# Run lint check
66+
npm run lint
67+
```
68+
69+
## Branching and Commit Conventions
70+
71+
### Branch Naming
72+
73+
- `feat/xxx` — New feature
74+
- `fix/xxx` — Bug fix
75+
- `docs/xxx` — Documentation improvement
76+
- `refactor/xxx` — Code refactoring
77+
78+
### Commit Message
79+
80+
We use the [Conventional Commits](https://www.conventionalcommits.org/) convention:
81+
82+
```
83+
<type>: <description>
84+
85+
[optional body]
86+
```
87+
88+
Common types:
89+
- `feat` — New feature
90+
- `fix` — Bug fix
91+
- `docs` — Documentation change
92+
- `style` — Code style (no functional impact)
93+
- `refactor` — Refactoring
94+
- `test` — Testing
95+
- `chore` — Build/tooling changes
96+
97+
Example:
98+
```
99+
feat: add quiz for Bitcoin Script lesson
100+
fix: correct image path in SegWit tutorial
101+
docs: update README with new learning path
102+
```
103+
104+
## Code Style
105+
106+
- Use ESLint + Prettier to maintain code consistency.
107+
- A `lint-staged` check will automatically run before each commit.
108+
- Manual formatting: `npm run format`
109+
110+
## PR Process
111+
112+
1. Ensure the code passes all tests: `npm test`.
113+
2. Ensure there are no linting errors: `npm run lint`.
114+
3. Fill in all necessary information in the PR template.
115+
4. Wait for Code Review.
116+
5. Make changes based on feedback.
117+
6. Delete the feature branch after merging.
118+
119+
## Tutorial Content Guidelines
120+
121+
When writing or modifying tutorials:
122+
123+
- Use Markdown format.
124+
- Place each lesson in an independent numbered directory (e.g., `01_FirstWeb3Identity/`).
125+
- Name the main file `README.MD`.
126+
- Place code examples in the `code_examples/` subdirectory.
127+
- Use relative paths for images.
128+
- Place Chinese content in the `zh/` directory and English content in the `en/` directory.
129+
130+
## Contact Us
131+
132+
- Twitter: [@bhbtc1337](https://twitter.com/bhbtc1337)
133+
- GitHub Issues: [Submit an issue](https://github.com/beihaili/Get-Started-with-Web3/issues)
134+
- WeChat Group: Apply via Google Form.
135+
136+
## Acknowledgments
137+
138+
Thanks to every contributor! Your participation makes Web3 education better.

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
> **README:** [English](README.md) | [中文](README.zh.md)
2+
> **CONTRIBUTING:** [English](CONTRIBUTING.en.md) | [中文](CONTRIBUTING.md)
23
34
# 贡献指南
45

0 commit comments

Comments
 (0)