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

Chalarangelo/30-seconds-of-code

菜单

贡献

相关源文件

本页面提供了贡献30-seconds-of-code项目的指南和说明。文档概述了您如何帮助改进项目，详细介绍了贡献的基本规则，并提出了写作指南，以在所有内容中保持一致性。

有关贡献代码时应遵循的代码标准信息，请参阅代码标准。

您如何提供帮助

30-seconds-of-code是一个社区支持的项目。您可以通过以下方式做出贡献：

  • 提交与错误或内容改进相关的issues
  • 创建pull requests来修复bug或改进内容
  • 提交错别字修复和语言改进

贡献流程

30-seconds-of-code的贡献流程遵循标准的开源工作流，并设有特定规则以确保高质量的贡献。

贡献工作流程图

来源： CONTRIBUTING.md5-14

基本规则

为维护高质量的代码库和积极的社区氛围，所有贡献者必须遵守以下基本规则：

  1. 始终对他人礼貌和尊重，并遵循维护者的建议
  2. 仅修改特定目录下的文件:
    • content/snippets/
    • content/collections/

任何违反这些规则的pull requests将被关闭。

内容修改范围

来源： CONTRIBUTING.md9-14

写作指南

30-seconds-of-code项目维护着特定的写作指南，以确保所有内容的一致性和清晰性。这些指南涵盖了语言使用、写作风格、格式和内容结构。

语言指南

方面指南
词语选择使用受众能理解的词语
拼写所有内容使用美式拼写
句子长度保持句子简短（20个单词以内）
重点每句话应只有一个焦点
编辑删除不必要或重复的词语
习语避免使用习语和意义间接的短语
行话除非必要，避免使用过于技术性的术语
阅读水平目标是10年级或以下的阅读水平
缩写使用自然的缩写，但不要过度

来源： CONTRIBUTING.md19-34

语气指南

项目使用一致的语气来保持可读性

  • 优先使用主动语态而非被动语态
  • 仅在强调动作而非主语时使用被动语态
  • 在记录代码片段时使用祈使句（“使用此方法”）
  • 避免使用许可性语言（“您可以使用此方法”）

来源： CONTRIBUTING.md35-42

代码内容结构

贡献代码片段或合集时，请遵循此结构模式

片段内容结构

来源： CONTRIBUTING.md88-96

格式指南

项目为各种内容元素维护着特定的格式指南

大写

  • 大写句子开头的字母，其余字母小写
  • 在术语、缩写、产品或商标的原始大写时保持不变

标点符号

  • 在正文中避免使用和号（&），用“and”代替
  • 在缩写、所有格或省略字符时使用撇号
  • 使用引号来定义单词或引用文本
  • 避免在句子中间使用句号，除非是在代码块或术语中
  • 谨慎使用冒号，主要用于引出列表
  • 句子中不要使用牛津逗号
  • 不要使用逗号分隔项目符号或编号列表项

来源： CONTRIBUTING.md43-66

内容元素

标题

标题应根据以下指南进行格式化

  • 将句子格式标题的第一个单词大写
  • 如果不是句子格式，可以大写每个单词的首字母
  • 在标题中避免使用标点符号（问题性文章的问号除外）
  • 保持标题简短（一行以内）
  • 使标题信息丰富且具有描述性
  • 使用标题来帮助构建内容并使其易于扫描

来源： CONTRIBUTING.md104-121

列表

  • 尽可能使用项目符号（无序）列表
  • 为顺序步骤使用编号列表
  • 列表项以大写字母开头
  • 列表项结尾不要使用逗号或分号
  • 如果任何列表项包含多个句子，请使用标点符号
  • 使用列表来提高内容的可读性

来源： CONTRIBUTING.md122-132

代码块

  • 使用适当的视觉元素包裹行内代码
  • 使用适当的视觉元素包裹重要值（数字、字符串、布尔值）
  • 使用多行代码块来处理跨越多行的代码
  • 为多行代码块提供适当的语言上下文和高亮
  • 描述原生代码时使用全称（例如：Function.prototype.apply()）
  • 避免在标题中使用代码块

来源： CONTRIBUTING.md88-96

内容类型和结构

30-seconds-of-code项目将内容组织成两种主要类型：片段（snippets）和合集（collections）。贡献内容时，理解这种结构至关重要。

内容类型关系

来源： CONTRIBUTING.md12-14

贡献内容

贡献30-seconds-of-code时，您应该专注于特定目录中的内容

  1. 片段 - 位于content/snippets/
  2. 合集 - 位于content/collections/

修改片段

修改或创建片段时，请确保：

  • 片段提供了针对特定问题的清晰、简洁的解决方案
  • 标题和描述准确反映了片段的目的
  • 代码遵循项目的代码标准
  • 示例演示了实际用法
  • 内容符合所有写作指南

修改合集

修改或创建合集时，请确保：

  • 合集以逻辑方式将相关片段分组
  • 标题和描述准确反映了合集的目的
  • 所有包含的片段都与合集相关
  • 内容符合所有写作指南

个人语气指南

撰写内容时，请遵循有关人称代词的指南

  • 在表达个人观点或经历时使用“我”或“我的”
  • 提及30-seconds-of-code团队时使用“我们”或“我们的”
  • 当读者跟随操作，并且您想让他们感到放心时，使用“我们”或“我们的”
  • 在向读者解释某事时使用“您”或“您的”

在内容中创建操作或链接时

  • 可能时，使用强动词引导操作（例如，“搜索”、“查看全部”）
  • 将操作的第一个单词大写，其余小写
  • 一致地标记链接
  • 仅将链接应用到句子中相关的文本上，而不是整个句子
  • 使链接具有描述性，无论是单独还是基于上下文

来源： CONTRIBUTING.md133-141

可访问性指南

确保内容可访问，请

  • 在可能的情况下为视觉内容提供替代文本
  • 为装饰性视觉内容使用空的替代文本
  • 创建有助于用户导航网站的替代文本
  • 使用通俗易懂的语言，避免不必要的词语

来源： CONTRIBUTING.md142-148

总结

贡献30-seconds-of-code项目涉及遵循特定指南，以维护项目的质量和一致性。通过遵守这些贡献指南，您有助于确保该项目成为社区宝贵的资源。

请记住

  • 尊重他人并遵循维护者的建议
  • 仅修改指定目录中的文件
  • 遵循所有写作指南
  • 确保内容清晰、简洁且有用