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

adam-p/markdown-here

菜单

贡献指南

相关源文件

本页面概述了向 Markdown Here 项目贡献的流程和要求。它提供了关于如何提交更改、签署所需的贡献者许可协议 (CLA) 以及遵循项目开发实践的详细说明。有关设置开发环境的信息，请参阅设置开发环境；有关测试流程，请参阅测试。

1. 贡献流程概述

向 Markdown Here 贡献涉及几个关键步骤，从设置开发环境到代码合并。项目遵循标准的开源贡献实践，并增加了特定的法律合规性要求。

来源：Makefile12-14 CLA-individual.md5-8 CLA-entity.md5-8

2. 设置开发环境

在贡献之前，请确保您已安装必要的工具

  1. Node.js 和 npm：构建扩展所需
  2. Git：用于版本控制
  3. 文本编辑器/IDE：您选择的任何编辑器

有关开发环境设置的详细说明，包括特定于浏览器的要求，请参阅设置开发环境。

来源：Makefile12-14

3. 构建扩展

Markdown Here 使用简单的构建流程

# Clean any previous builds and create a new build
make build

# Or run the build script directly
cd utils
node build.js

构建流程将扩展打包为适用于不同浏览器平台（包括 Chrome、Firefox 和 Thunderbird）的版本。

来源：Makefile12-14

4. 贡献者许可协议 (CLA)

所有贡献者必须在其贡献被接受之前签署贡献者许可协议 (CLA)。这是一项法律要求，允许项目维护其许可模型。

CLA 流程

CLA 要求

  1. 个人贡献者：如果您以个人身份贡献，则需要签署个人 CLA。
  2. 实体贡献者：如果您代表组织或公司贡献，则必须签署实体 CLA。

如何签署 CLA

  1. 阅读相应的 CLA 文档

  2. 在 /contributors 目录下创建一个新文件，以您的 GitHub 用户名作为文件名（例如，your-username.md）。

  3. 将以下文本添加到文件中，用您的信息替换占位符

    <Date>

I hereby agree to the terms of the "Markdown Here [Individual/Entity] Contributor License Agreement", with MD5 checksum dda72cea89d55de9fda0a102494134b4.

I furthermore declare that I am authorized and able to make this agreement and sign this declaration.

Signed,

[Your Name] https://github.com/[your-github-username]

  4. 将此文件包含在您的拉取请求中。

来源：CLA-individual.md CLA-entity.md contributors/adam-p.md

5. 代码贡献指南

分支策略

  1. 创建功能分支：始终为您的更改创建一个新分支
  2. 描述性分支名称：使用能够反映您的更改目的的描述性名称

代码风格指南

尽管项目在提供的文件中没有明确的文档风格指南，但请遵循以下通用最佳实践

  1. 与现有代码风格保持一致
  2. 使用清晰的变量和函数名称
  3. 添加注释以解释复杂逻辑
  4. 使函数专注于单一职责

提交指南

  1. 编写清晰的提交消息，解释更改的目的
  2. 使提交专注于单一逻辑更改
  3. 在适用的情况下，在提交消息中引用问题编号

6. 拉取请求流程

当您的更改准备好进行审查时，请遵循以下步骤

  1. 确保您的分支与主分支保持最新
  2. 确保您的代码可以无错误构建
  3. 彻底测试您的更改（请参阅测试）
  4. 向主仓库提交拉取请求
  5. 提供对更改及其目的的清晰描述
  6. 积极响应反馈并根据要求进行更改

来源：CLA-individual.md6-8 CLA-entity.md6-8

许可

Markdown Here 采用 MIT 许可证授权。所有贡献将根据相同的条款获得许可。

贡献者保留对其贡献的版权，但授予项目 CLA 中概述的权利，以分发和许可代码。

第三方代码

如果您的贡献包含第三方代码

  1. 确保其与 MIT 许可证兼容
  2. 清晰地记录来源和许可证
  3. 在此类情况下，请遵循 CLA 中的说明

来源：LICENSE CLA-individual.md14-18 CLA-entity.md14-18

8. 获取帮助

如果您在贡献过程中需要帮助

  1. 查阅现有文档
  2. 在 GitHub 上提交问题以寻求澄清
  3. 联系项目维护者

9. 本地化贡献

Markdown Here 支持多种语言。如果您正在贡献翻译

  1. 在 src/_locales/ 下的相应语言环境目录中添加或修改文件
  2. 遵循与现有语言环境文件相同的文件结构
  3. 像代码贡献一样签署 CLA

来源：src/_locales/fr/description.txt src/_locales/zh_CN/description.txt src/_locales/ru/description.txt

遵循这些指南，您将有助于维护 Markdown Here 项目的质量和一致性。感谢您的贡献！