在 Devin 中试用 DeepWiki 处理私有仓库
DeepWiki

leonardomso/33-js-concepts

菜单

贡献指南

相关源文件

目的与范围

本文档概述了为 33 JavaScript Concepts 存储库贡献的流程和标准。该存储库是 JavaScript 开发者的综合学习资源，涵盖 33 个基本概念，并提供精选的文章、视频和其他教育材料。

来源： README.md10-14 README.md16-18

贡献类型

该项目欢迎多种形式的贡献

  1. 添加学习资源 - 为 33 个 JavaScript 概念中的任何一个提交新的文章、视频或书籍
  2. 翻译存储库 - 创建内容的不同语言版本
  3. 修复错误 - 纠正损坏的链接、拼写错误或不准确的信息
  4. 改进组织 - 增强资源的结构和分类

来源： README.md16-18 README.md20-64

贡献工作流程

贡献流程概述

来源： README.md16-18

分步说明

  1. Fork 存储库：在 GitHub 上创建存储库的副本
  2. 本地克隆：将你的 fork 下载到本地计算机
    git clone https://github.com/YOUR-USERNAME/33-js-concepts.git
  3. 创建分支：为你的贡献创建一个新分支
    git checkout -b your-branch-name
  4. 进行更改：添加资源、翻译或修复错误
  5. 测试更改：确保你的更改正确显示并且链接有效
  6. 提交和推送：将你的更改推送到你的 fork
  7. 创建拉取请求：提交你的更改以供审查

来源： README.md16-18

添加资源的指南

在为任何 33 个概念添加新的学习资源时，请遵循以下指南

资源结构

来源： README.md110-123 README.md167-177

资源添加指南

  1. 相关性：确保资源与特定的 JavaScript 概念直接相关

  2. 质量：仅提交高质量的资源，内容准确且解释得当

  3. 格式：遵循每种资源类型的既定格式

    - <FileRef file-url="https://github.com/leonardomso/33-js-concepts/blob/8e89373c/Resource Title — Author/Creator Name" undefined  file-path="Resource Title — Author/Creator Name">Hii</FileRef>

  4. 放置：将新资源添加到相应部分的末尾

  5. 独特性：通过检查现有资源来避免重复提交

来源： README.md110-123 README.md167-177

翻译指南

该存储库鼓励翻译，以使内容能够被非英语使用者访问。

翻译流程

来源： README.md20-64

翻译要求

  1. 完整翻译：翻译整个 README.md 文件，包括所有 33 个概念

  2. 单独托管：在您自己的 GitHub 存储库中托管您的翻译

  3. 提交 PR：在主存储库的 README 中添加指向您的翻译的链接

  4. 格式：翻译列表遵循此格式

    - <FileRef file-url="https://github.com/leonardomso/33-js-concepts/blob/8e89373c/Language Name (Native Language Name)" undefined  file-path="Language Name (Native Language Name)">Hii</FileRef> — Your Name

  5. 维护：使您的翻译与主存储库中的更改保持同步

来源： README.md20-64

质量保证

该存储库使用自动化流程来维护质量

来源： .github/workflows/action.yml1-11

  1. 自动检查：所有拉取请求和推送都会触发对损坏链接的自动检查
  2. 修复损坏的链接：如果工作流失败，请在合并前修复所有损坏的链接
  3. 定期维护：定期审查和更新链接以防止链接失效

来源： .github/workflows/action.yml1-11

内容指南

资源类别

类别描述示例格式
参考官方文档或主要来源<FileRef file-url="https://github.com/leonardomso/33-js-concepts/blob/8e89373c/Concept Name — MDN" undefined file-path="Concept Name — MDN">Hii</FileRef>
文章博客文章、教程、解释<FileRef file-url="https://github.com/leonardomso/33-js-concepts/blob/8e89373c/Article Title — Author Name" undefined file-path="Article Title — Author Name">Hii</FileRef>
视频YouTube 视频、课程、演讲<FileRef file-url="https://github.com/leonardomso/33-js-concepts/blob/8e89373c/Video Title — Creator/Channel" undefined file-path="Video Title — Creator/Channel">Hii</FileRef>
书籍已出版的书籍、电子书、章节<FileRef file-url="https://github.com/leonardomso/33-js-concepts/blob/8e89373c/Book Title — Author" undefined file-path="Book Title — Author">Hii</FileRef>

来源： README.md110-123 README.md167-177

内容标准

  1. 准确性：资源应包含技术上准确的信息
  2. 时效性：优先选择与现代 JavaScript 实践同步的资源
  3. 深度：资源应提供实质性的解释，而不仅仅是表面覆盖
  4. 可访问性：如果可能，内容应在无付费墙的情况下访问
  5. 多样性：包含来自不同作者和视角的资源

来源： README.md110-123 README.md167-177

社区准则

通信

  1. 尊重他人：以尊重和礼貌的态度对待所有贡献者
  2. 建设性：对拉取请求提供建设性的反馈
  3. 耐心：维护者是志愿者，可能不会立即回复
  4. 包容性：鼓励来自不同背景的人贡献

识别

贡献者通过以下方式获得认可

  1. 提交历史：您的提交将记录在存储库历史中
  2. 翻译致谢：翻译人员将在主 README 中获得认可
  3. 社区认可：重要贡献可能会在存储库更新中突出显示

来源： README.md20-64

结论

您的贡献有助于使 33 JavaScript Concepts 存储库成为全球 JavaScript 开发者的宝贵资源。通过遵循这些指南，您可以确保该项目保持高质量和实用性，造福整个社区。

如果您有这些指南未涵盖的问题，请随时在存储库中打开一个 issue 以寻求澄清。

感谢您为 JavaScript 社区知识库做出贡献！