使用示例指南模板

示例指南的目的

示例指南模板是应用程序创意集合中所有项目提交的标准格式。它提供了一个结构化的框架，确保每个项目提案都包含所有必要的信息。

来源：Example Guide.md1-33 CONTRIBUTING.md5

模板结构概览

示例指南模板包含定义完整项目创意的几个重要部分

来源：Example Guide.md1-33

使用模板的分步指南

1. 项目标题和级别

在项目提案的开头，提供清晰、描述性的标题，并分配适当的难度级别。

# Application Name

**Tier:** Add corresponding tier (1-Beginner, 2-Intermediate, 3-Advanced)

标题应简洁而具有描述性
根据复杂性和所需技能选择级别
- 级别 1：适合具有基本编程知识的初学者
- 级别 2：需要中级技能和一些经验
- 级别 3：高级项目，需要全面的开发技能

来源：Example Guide.md1-3

2. 项目描述

提供清晰、全面的应用程序描述

Add a clear description of the application and its main features.
Answer the following questions:

- "What is the purpose of this application?"
- "Are there any resources needed in order to complete the project?" - If yes, be sure to add it.

一个好的描述应该

清晰说明应用程序的目的
概述主要功能和作用
识别任何先决条件或所需资源
简洁而信息丰富

来源：Example Guide.md5-9

3. 用户故事

用户故事从最终用户的角度定义了应用程序的核心需求

## User Stories

- [ ] User can ... first user story
- [ ] User can ... second user story
- [ ] User can ... third user story

撰写用户故事时

将其格式化为“用户可以……”的语句
按逻辑顺序排列它们，从核心功能开始
每个故事都应侧重于一项功能
使用复选框格式（- [ ]）使需求清晰
包含足够的故事来定义一个完整的应用程序

来源：Example Guide.md11-18

4. 附加功能

附加功能提供可选的增强功能，可扩展基本应用程序

## Bonus features

- [ ] User can ... first bonus feature
- [ ] User can ... second bonus feature
- etc...

定义附加功能时

包含增强或扩展核心功能的附加功能
使用复选框以与用户故事一致的方式进行格式化
确保它们确实是可选的（对基本功能不是必需的）
考虑附加功能的变化难度级别

来源：Example Guide.md20-24

5. 有用的链接和资源

提供有助于开发人员实现项目的资源

## Useful links and resources

Add useful links and resources corresponding to this project.

有效的资源可能包括

相关技术的文档
特定技术的教程
适用的 API 文档
有用的库或工具
设计指南或模式

来源：Example Guide.md26-28

6. 示例项目

引用演示类似功能的现有实现

## Example projects

Add one or more examples of projects that have similar functionality to this application. This will act as a developer guide.

好的示例项目

演示类似的 G 核心功能
展示概念的实际实现
为开发人员提供视觉参考
代表可实现的结果
如果可能，包括不同的方法

来源：Example Guide.md30-32

模板使用流程

下图说明了示例指南模板如何融入整体贡献流程

来源：CONTRIBUTING.md1-10 Example Guide.md1-33

常见陷阱和最佳实践

模板完成清单

章节	常见陷阱	最佳实践
标题和级别	标题含糊不清，级别评估不正确	要具体，诚实地评估复杂性
描述	太简短，缺少目的	回答所有提示问题，要全面
用户故事	故事太少，需求不明确	涵盖完整功能，使用清晰的语言
附加功能	将必需功能作为“附加功能”	确保核心应用程序在没有这些功能的情况下也能正常工作
资源	链接丢失或过时	验证链接，提供多样化的资源
示例	示例与提案不同	查找非常相似的实现

来源：Example Guide.md1-33 CONTRIBUTING.md5-8

模板到项目结构的映射

下图显示了示例指南模板如何映射到存储库中的实际项目结构