前端技术文档

Appearance

贡献指南 ​

感谢您对本项目的关注！以下是参与贡献的基本流程和规范。通过遵循这些指南，您可以帮助我们改进和扩展这个前端技术文档平台。

贡献类型 ​

您可以通过多种方式为本项目做出贡献：

  1. 内容贡献：编写或改进技术文档
  2. 代码贡献：改进网站功能或修复问题
  3. 示例贡献：提供高质量的代码示例或演示
  4. 问题反馈：报告错误或提出改进建议
  5. 文档翻译：将文档翻译成其他语言

贡献流程 ​

1. 准备工作 ​

在开始贡献之前，请确保您已经：

  • 拥有一个 GitHub 账号
  • 了解基本的 Git 操作
  • 熟悉 Markdown 语法

2. 分支管理 ​

我们使用以下分支管理策略：

  • main：主分支，包含稳定版本的文档
  • develop：开发分支，用于集成贡献者的更改
  • 特性分支：基于 develop 创建的临时分支，用于开发特定功能或修复

3. 贡献步骤 ​

内容贡献 ​

  1. Fork 本仓库到您的 GitHub 账号
  2. 克隆您的 Fork 到本地
    bash
    git clone https://github.com/your-username/frontend-docs.git
cd frontend-docs
  3. 创建一个新的特性分支
    bash
    git checkout -b feature/your-feature-name
  4. 进行更改并提交
    bash
    git add .
git commit -m "docs: add content for XYZ technology"
  5. 推送到您的 Fork
    bash
    git push origin feature/your-feature-name
  6. 创建一个 Pull Request 到我们的 develop 分支

问题反馈 ​

  1. 在 GitHub Issues 页面创建一个新的 Issue
  2. 使用适当的 Issue 模板
  3. 提供详细的问题描述和复现步骤
  4. 如果可能，附上截图或错误日志

文档规范 ​

文件命名 ​

  • 使用小写字母和连字符（例如：getting-started.md，code-of-conduct.md）
  • 文件名应简洁明了，反映内容主题

Markdown 格式 ​

  • 使用 ATX 风格的标题（# 符号）
  • 代码块应指定语言类型
  • 使用无序列表（-）和有序列表（1.）
  • 链接文本应有意义，避免使用"点击这里"等模糊表述

内容风格 ​

  • 使用简洁、清晰的语言
  • 避免使用过于技术性的术语，如必须使用，请提供解释
  • 提供实际示例和用例
  • 包含适当的参考资料和引用

代码示例 ​

  • 提供完整、可运行的代码示例
  • 添加详细的注释解释关键部分
  • 遵循相应语言的编码规范
  • 尽可能包含错误处理
javascript
// 好的示例
try {
  const data = await fetchUserData(userId);
  renderUserProfile(data);
} catch (error) {
  console.error('Failed to fetch user data:', error);
  showErrorMessage('无法加载用户数据，请稍后再试');
}

审核流程 ​

所有贡献都将经过以下审核流程：

  1. 初步审核：检查基本格式和完整性
  2. 技术审核：验证技术内容的准确性
  3. 语言审核：检查语法、拼写和表达
  4. 最终审核：确保与现有内容的一致性

我们会在 Pull Request 中提供反馈，可能会要求进行修改。一旦所有审核通过，您的贡献将被合并到项目中。

版权和许可 ​

通过贡献内容，您同意将您的贡献置于与本项目相同的许可证下。所有贡献者都将在贡献者列表中得到认可。

获取帮助 ​

如果您在贡献过程中需要帮助，可以：

再次感谢您的贡献！您的参与对于保持这个文档平台的质量和实用性至关重要。