Skip to content

Commit 63d9ad8

Browse files
Charliechen114514Charliechen114514
committed
feat: contributor ready
1 parent ecfe4c7 commit 63d9ad8

19 files changed

Lines changed: 713 additions & 29 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,30 @@ pnpm dev
147147
2. CI 检查必须通过（markdown lint、链接检查）
148148
3. 审核通过后，维护者将合并代码
149149

150+
## 非代码贡献
151+
152+
我们同样重视非代码形式的贡献！以下贡献方式均会被记录在 [CONTRIBUTORS.md](./CONTRIBUTORS.md) 中：
153+
154+
| 贡献类型 | 说明 | 如何参与 |
155+
|---------|------|---------|
156+
| 界面设计 | 文档站 UI/UX 优化 | 通过 Issue 提交设计方案 |
157+
| 插画配图 | 教程插图、架构图 | 通过 Issue 或邮件提交 |
158+
| 问题反馈 | 发现错误或不准确之处 | 提交 Issue 或通过微信/QQ/邮件反馈 |
159+
| 内容建议 | 新主题建议、改进意见 | 提交 Issue 或通过微信/QQ/邮件反馈 |
160+
| 内容审阅 | 技术校对、审阅 | 通过 Issue 或邮件参与 |
161+
| 翻译 | 英文翻译 | 通过 PR 提交 |
162+
163+
### 匿名贡献
164+
165+
如果您希望匿名贡献，请在反馈时注明。我们会使用化名或不具名记录您的贡献。
166+
167+
### 贡献者记录
168+
169+
所有贡献者会被记录在：
170+
171+
- [CONTRIBUTORS.md](./CONTRIBUTORS.md) — 完整贡献者列表
172+
- [文档站贡献者页面](https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeModernCPP/team/) — 在线展示
173+
150174
## 行为准则
151175

152176
- 尊重所有贡献者

‎CONTRIBUTORS.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# 贡献者
2+
3+
感谢所有为本项目做出贡献的人！
4+
5+
## 贡献类型说明
6+
7+
| 图标 | 类型 | 说明 |
8+
|:----:|------|------|
9+
| 🎨 | 界面设计 | UI/UX 设计、视觉优化 |
10+
| 🖼️ | 插画/配图 | 教程插图、架构图、流程图 |
11+
| 🐛 | 问题反馈 | 通过 Issue、微信、QQ、邮件等渠道反馈错误 |
12+
| 📝 | 内容建议 | 提供内容改进建议、学习路径优化 |
13+
| 🔍 | 审阅 | 内容审阅、技术校对 |
14+
| 🌍 | 翻译 | 英文翻译或其他语言翻译 |
15+
| 💡 | 示例代码 | 提供代码示例或改进建议 |
16+
| 📢 | 推广宣传 | 帮助传播项目 |
17+
18+
## 贡献者列表
19+
20+
<!--
21+
添加新贡献者时，请复制以下模板并填写：
22+
23+
### [贡献者名称或化名]
24+
25+
**贡献类型**：图标列表（如 🎨 🖼️）
26+
**贡献渠道**：GitHub / 微信 / QQ / 邮件 / 其他
27+
**贡献说明**：简要描述贡献内容
28+
29+
如果贡献者希望匿名，名称字段填写化名，不需要提供联系方式。
30+
-->
31+
32+
### Charliechen
33+
34+
**贡献类型**：📝 🔍 💡
35+
**贡献渠道**：GitHub
36+
**贡献说明**：项目维护者，教程主要作者
37+
38+
<!-- 在此处添加更多贡献者 -->
39+
40+
### [Doll-Attire](https://github.com/Doll-Attire)
41+
42+
**贡献类型**：🎨 📝
43+
**贡献渠道**：微信
44+
**贡献说明**：指导文档站 UI 设计，提供阅读体验改进意见

‎README.en.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,21 @@ If you have questions, feel free to open an issue at [GitHub Issues](https://git
191191

192192
---
193193

194+
## Contributors
195+
196+
Thanks to everyone who has contributed to this project! See [CONTRIBUTORS.md](./CONTRIBUTORS.md) for details.
197+
198+
<!-- ALL_CONTRIBUTORS_START -->
199+
| Contributor | Contributions |
200+
|-------------|--------------|
201+
| [Charliechen](https://github.com/Charliechen114514) | 📝 Content · 🔍 Review · 💡 Examples |
202+
| [Doll-Attire](https://github.com/Doll-Attire) | 🎨 UI Design · 📝 UX Improvements |
203+
<!-- ALL_CONTRIBUTORS_END -->
204+
205+
> Contributions are not limited to code — UI design, illustrations, issue reports, and content suggestions all count. See [CONTRIBUTING.md](./CONTRIBUTING.md).
206+
207+
---
208+
194209
## Acknowledgements
195210

196211
This project references the following excellent resources:

‎README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,21 @@ Tutorial_AwesomeModernCPP/
195195

196196
---
197197

198+
## 贡献者
199+
200+
感谢所有为本项目做出贡献的人！详见 [CONTRIBUTORS.md](./CONTRIBUTORS.md)。
201+
202+
<!-- ALL_CONTRIBUTORS_START -->
203+
| 贡献者 | 贡献类型 |
204+
|--------|---------|
205+
| [Charliechen](https://github.com/Charliechen114514) | 📝 内容 · 🔍 审阅 · 💡 示例 |
206+
| [Doll-Attire](https://github.com/Doll-Attire) | 🎨 界面设计 · 📝 体验改进 |
207+
<!-- ALL_CONTRIBUTORS_END -->
208+
209+
> 贡献方式不限于代码，包括界面设计、插画、问题反馈、内容建议等。详见 [CONTRIBUTING.md](./CONTRIBUTING.md)。
210+
211+
---
212+
198213
## 致谢
199214

200215
本项目参考了以下优秀资源：

‎documents/en/index.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,3 @@ features:
9191
link: /en/tags/
9292
linkText: Browse Tags
9393
---
94-
95-
> Please note that tutorials are time-sensitive. We recommend comparing the publication dates and adapting the content accordingly. The official documentation should always be your primary reference.

‎documents/en/team/index.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Contributors
3+
description: "Thanks to everyone who has contributed to this project"
4+
---
5+
6+
# Contributors
7+
8+
Thanks to everyone who has contributed to this project! Whether it's code, design, illustrations, issue reports, or content suggestions — your help makes this tutorial better.
9+
10+
## Contribution Types
11+
12+
| Icon | Type | Description |
13+
|:----:|------|-------------|
14+
| 🎨 | Design | UI/UX design, visual improvements |
15+
| 🖼️ | Illustration | Tutorial diagrams, architecture charts, flowcharts |
16+
| 🐛 | Bug Reports | Error reports via Issues, WeChat, QQ, email, etc. |
17+
| 📝 | Content Suggestions | Content improvement ideas, learning path optimization |
18+
| 🔍 | Review | Content review, technical proofreading |
19+
| 🌍 | Translation | English or other language translations |
20+
| 💡 | Code Examples | Providing or improving code examples |
21+
| 📢 | Promotion | Helping spread the word |
22+
23+
## Contributor List
24+
25+
::: info About Anonymous Contributors
26+
Some contributors prefer to remain anonymous or use pseudonyms. We appreciate them equally.
27+
:::
28+
29+
<div class="contributor-grid">
30+
<a href="https://github.com/Charliechen114514" target="_blank" rel="noopener noreferrer" class="contributor-card">
31+
<img src="https://github.com/Charliechen114514.png?size=96" alt="Charliechen" class="card-avatar" />
32+
<div class="card-body">
33+
<span class="card-name">Charliechen</span>
34+
<p class="card-role">Project Maintainer · Lead Author</p>
35+
<p class="card-types">📝 🔍 💡</p>
36+
<p class="card-desc">Primary tutorial author, project architecture design and ongoing maintenance</p>
37+
</div>
38+
</a>
39+
<a href="https://github.com/Doll-Attire" target="_blank" rel="noopener noreferrer" class="contributor-card">
40+
<img src="https://github.com/Doll-Attire.png?size=96" alt="Doll-Attire" class="card-avatar" />
41+
<div class="card-body">
42+
<span class="card-name">Doll-Attire</span>
43+
<p class="card-role">UI Design Advisor</p>
44+
<p class="card-types">🎨 📝</p>
45+
<p class="card-desc">Guided the documentation site UI design and provided reading experience improvement suggestions</p>
46+
</div>
47+
</a>
48+
</div>
49+
50+
## How to Become a Contributor
51+
52+
We welcome all forms of contribution, including but not limited to:
53+
54+
- **Submit an Issue**: Report errors or inaccuracies
55+
- **Content Suggestions**: Suggest new topics or improvements
56+
- **UI Design**: Propose UI/UX improvements for the documentation site
57+
- **Illustrations**: Create diagrams or flowcharts for tutorials
58+
- **Translation**: Help translate tutorial content
59+
- **Code Examples**: Provide better code examples
60+
61+
Contact us through any of these channels:
62+
63+
- [GitHub Issues](https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/issues)
64+
- Email: <725610365@qq.com>
65+
66+
See the [Contributing Guide](https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/blob/main/CONTRIBUTING.md) for details.

‎documents/index.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,3 @@ features:
9191
link: /tags/
9292
linkText: 浏览标签
9393
---
94-
95-
> 请注意，教程具备时效性，所以请您自己先自行对比时间参考，然后类比迁移，以及，官方文档总是你的第一参考人。

‎documents/team/index.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: 贡献者
3+
description: "感谢所有为本项目做出贡献的人"
4+
---
5+
6+
# 贡献者
7+
8+
感谢每一位为本项目做出贡献的人！无论是代码、设计、插画、问题反馈还是内容建议，你们的帮助都让这个教程变得更好。
9+
10+
## 贡献类型
11+
12+
| 图标 | 类型 | 说明 |
13+
|:----:|------|------|
14+
| 🎨 | 界面设计 | UI/UX 设计、视觉优化 |
15+
| 🖼️ | 插画/配图 | 教程插图、架构图、流程图 |
16+
| 🐛 | 问题反馈 | 通过 Issue、微信、QQ、邮件等渠道反馈错误 |
17+
| 📝 | 内容建议 | 提供内容改进建议、学习路径优化 |
18+
| 🔍 | 审阅 | 内容审阅、技术校对 |
19+
| 🌍 | 翻译 | 英文翻译或其他语言翻译 |
20+
| 💡 | 示例代码 | 提供代码示例或改进建议 |
21+
| 📢 | 推广宣传 | 帮助传播项目 |
22+
23+
## 贡献者名单
24+
25+
::: info 关于匿名贡献者
26+
部分贡献者出于隐私考虑选择匿名或使用化名，我们对他们同样表示感谢。
27+
:::
28+
29+
<div class="contributor-grid">
30+
<a href="https://github.com/Charliechen114514" target="_blank" rel="noopener noreferrer" class="contributor-card">
31+
<img src="https://github.com/Charliechen114514.png?size=96" alt="Charliechen" class="card-avatar" />
32+
<div class="card-body">
33+
<span class="card-name">Charliechen</span>
34+
<p class="card-role">项目维护者 · 主要作者</p>
35+
<p class="card-types">📝 🔍 💡</p>
36+
<p class="card-desc">教程主要编写者，资源收集和开发，项目架构设计与基础的日常维护</p>
37+
</div>
38+
</a>
39+
<a href="https://github.com/Doll-Attire" target="_blank" rel="noopener noreferrer" class="contributor-card">
40+
<img src="https://github.com/Doll-Attire.png?size=96" alt="Doll-Attire" class="card-avatar" />
41+
<div class="card-body">
42+
<span class="card-name">Doll-Attire</span>
43+
<p class="card-role">UI 设计指导与意见反馈</p>
44+
<p class="card-types">🎨 📝</p>
45+
<p class="card-desc">指导本文档站 UI 设计，提供重要的阅读体验改进意见</p>
46+
</div>
47+
</a>
48+
</div>
49+
50+
## 如何成为贡献者
51+
52+
我们欢迎各种形式的贡献！包括但不限于：
53+
54+
- **提交 Issue**：发现错误或不准确之处
55+
- **内容建议**：希望增加的主题或改进建议
56+
- **界面设计**：文档站 UI/UX 优化方案
57+
- **插画配图**：为教程绘制示意图、流程图
58+
- **翻译**：帮助翻译教程内容
59+
- **代码示例**：提供更好的代码示例
60+
61+
请通过以下任意渠道联系我们：
62+
63+
- [GitHub Issues](https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/issues)
64+
- 邮箱：<725610365@qq.com>
65+
66+
详见 [贡献指南](https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP/blob/main/CONTRIBUTING.md)。

‎documents/vol1-fundamentals/index.md‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,30 +14,34 @@ tags:
1414

1515
## 章节导航
1616

17-
- [ch00：环境搭建与第一个程序](ch00/)
18-
- [ch01：类型与值类别](ch01/)
19-
- [ch02：控制流](ch02/)
20-
- [ch03：函数](ch03/)
21-
- [ch04：指针与引用](ch04/)
22-
- [ch05：数组与字符串](ch05/)
23-
- [ch06：类与面向对象](ch06/)
24-
- [ch07：运算符重载](ch07/)
25-
- [ch08：继承与多态](ch08/)
26-
- [ch09：模板初步](ch09/)
27-
- [ch10：异常处理](ch10/)
28-
- [ch11：STL 初见](ch11/)
29-
- [ch12：内存模型基础](ch12/)
17+
<ChapterNav>
18+
<ChapterLink num="0" href="ch00/">环境搭建与第一个程序</ChapterLink>
19+
<ChapterLink num="1" href="ch01/">类型与值类别</ChapterLink>
20+
<ChapterLink num="2" href="ch02/">控制流</ChapterLink>
21+
<ChapterLink num="3" href="ch03/">函数</ChapterLink>
22+
<ChapterLink num="4" href="ch04/">指针与引用</ChapterLink>
23+
<ChapterLink num="5" href="ch05/">数组与字符串</ChapterLink>
24+
<ChapterLink num="6" href="ch06/">类与面向对象</ChapterLink>
25+
<ChapterLink num="7" href="ch07/">运算符重载</ChapterLink>
26+
<ChapterLink num="8" href="ch08/">继承与多态</ChapterLink>
27+
<ChapterLink num="9" href="ch09/">模板初步</ChapterLink>
28+
<ChapterLink num="10" href="ch10/">异常处理</ChapterLink>
29+
<ChapterLink num="11" href="ch11/">STL 初见</ChapterLink>
30+
<ChapterLink num="12" href="ch12/">内存模型基础</ChapterLink>
31+
</ChapterNav>
3032

3133
## 补充材料
3234

33-
- [前言](00-preface.md)
34-
- [C 语言速通复习](02-c-language-crash-course.md)
35-
- [C++98 入门：命名空间、引用与作用域解析](03A-cpp98-namespace-reference.md)
36-
- [C++98 函数接口：重载与默认参数](03B-cpp98-function-overload-default-args.md)
37-
- [C++98 面向对象：类与对象深度剖析](03C-cpp98-classes-and-objects.md)
38-
- [C++98 面向对象：继承与多态](03D-cpp98-inheritance-polymorphism.md)
39-
- [C++98 运算符重载](03E-cpp98-operator-overloading.md)
40-
- [C++98 进阶：类型转换、动态内存与异常处理](03F-cpp98-casts-memory-exceptions.md)
41-
- [何时用 C++、用哪些 C++ 特性](04-when-to-use-cpp.md)
42-
- [语言选择原则：性能 vs 可维护性的真实取舍](05-language-choice-performance-vs-maintainability.md)
43-
- [C 语言教程（详细版）](c_tutorials/) — 适合没有 C 语言基础的读者
35+
<ChapterNav variant="sub">
36+
<ChapterLink href="00-preface.md">前言</ChapterLink>
37+
<ChapterLink href="02-c-language-crash-course.md">C 语言速通复习</ChapterLink>
38+
<ChapterLink href="03A-cpp98-namespace-reference.md">C++98 入门：命名空间、引用与作用域解析</ChapterLink>
39+
<ChapterLink href="03B-cpp98-function-overload-default-args.md">C++98 函数接口：重载与默认参数</ChapterLink>
40+
<ChapterLink href="03C-cpp98-classes-and-objects.md">C++98 面向对象：类与对象深度剖析</ChapterLink>
41+
<ChapterLink href="03D-cpp98-inheritance-polymorphism.md">C++98 面向对象：继承与多态</ChapterLink>
42+
<ChapterLink href="03E-cpp98-operator-overloading.md">C++98 运算符重载</ChapterLink>
43+
<ChapterLink href="03F-cpp98-casts-memory-exceptions.md">C++98 进阶：类型转换、动态内存与异常处理</ChapterLink>
44+
<ChapterLink href="04-when-to-use-cpp.md">何时用 C++、用哪些 C++ 特性</ChapterLink>
45+
<ChapterLink href="05-language-choice-performance-vs-maintainability.md">语言选择原则：性能 vs 可维护性的真实取舍</ChapterLink>
46+
<ChapterLink href="c_tutorials/">C 语言教程（详细版）</ChapterLink>
47+
</ChapterNav>

‎scripts/build.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ const VOLUMES: Volume[] = [
3636
{ name: 'cpp-reference', srcDir: 'cpp-reference', urlPrefix: '/cpp-reference' },
3737
{ name: 'projects', srcDir: 'projects', urlPrefix: '/projects' },
3838
{ name: 'appendix', srcDir: 'appendix', urlPrefix: '/appendix' },
39+
{ name: 'team', srcDir: 'team', urlPrefix: '/team' },
3940
]
4041

4142
const PROJECT_ROOT = resolve(import.meta.dirname, '..')

0 commit comments

Comments
 (0)