README 与 Issue 模板

Markdown 最有价值的地方，是它能形成可预期的文档结构。

README 结构

一个实用的开源 README 通常包含：

# 项目名称

一句话说明项目用途。

## 功能
- 功能 A
- 功能 B

## 快速开始
```bash
npm install
npm run dev

配置

说明环境变量或配置文件。

许可证

MIT

读者会快速扫读 README，因此应把项目用途和快速开始放在靠前位置。

## CHANGELOG 写法

```markdown
## 1.2.0 - 2026-05-31
### 新增
- CSV 转 JSON 工具

### 修复
- 移动端工具栏换行问题

使用日期分段，并按变更类型分组，发布说明才容易浏览。

Issue 模板

Issue 模板应引导用户提供可复现信息：

## Bug 报告
**问题描述**

**复现步骤**
1.
2.

**期望行为**

**环境**
- OS:
- Browser:

好的模板能减少来回沟通，让缺失信息一目了然。

关键结论

高质量的 README 与 Issue Markdown 靠结构，而不是装饰。用标题建立浏览路径，并把示例放在对应章节附近。

发布前可在 Markdown 预览 / Markdown 转 HTML 工具 中加载 README 或 Issue 示例，检查标题层级是否合理。