贡献

相关源文件

• .github/ISSUE_TEMPLATE/bug-report.yml
• .github/ISSUE_TEMPLATE/config.yml
• .github/ISSUE_TEMPLATE/doc.md
• .github/ISSUE_TEMPLATE/feature-request.md
• ci/lib.sh
• ci/steps/publish-npm.sh

本页面提供了对 code-server 项目进行贡献的指南。无论是报告错误、提交功能请求、改进文档还是贡献代码，本指南都将帮助您了解贡献流程。

贡献流程概述

code-server 项目欢迎社区的贡献。贡献流程遵循标准的开源工作流程，从创建 issue 到提交和审查 pull request。

来源：.github/ISSUE_TEMPLATE/bug-report.yml、.github/ISSUE_TEMPLATE/feature-request.md、.github/ISSUE_TEMPLATE/doc.md

报告问题

在贡献代码之前，通常最好先创建一个 issue。这有助于维护者了解您打算进行的更改并提供指导。

Issue 类型

项目使用多种 issue 模板来组织贡献

问题类型	目的	模板
Bug 报告	报告意外行为或错误	.github/ISSUE_TEMPLATE/bug-report.yml
功能请求	建议新功能	.github/ISSUE_TEMPLATE/feature-request.md
文档改进	建议改进文档	.github/ISSUE_TEMPLATE/doc.md

Bug 报告

报告 bug 时，请提供详细信息，以帮助维护者重现和修复问题

1. 环境详情：浏览器、本地操作系统、远程操作系统、架构和 code-server 版本
2. 重现步骤：清晰、编号的步骤
3. 预期行为 vs. 实际行为：应该发生什么以及实际发生什么
4. 日志和屏幕截图：包含详细的日志和视觉证据
5. 与原生 VS Code 的比较：指明问题是否也发生在原生 VS Code 中

bug 报告模板强制包含这些信息。

来源：.github/ISSUE_TEMPLATE/bug-report.yml

功能请求

功能请求应清晰阐述

• 建议的功能是什么
• 为什么它会有价值
• 任何现有的解决方法
• 您是否有兴趣亲自实现它

来源：.github/ISSUE_TEMPLATE/feature-request.md

文档改进

文档改进应说明

• 需要改进什么
• 建议的更改将如何改进文档
• 您是否有兴趣亲自提交更改

来源：.github/ISSUE_TEMPLATE/doc.md

设置开发环境

要为 code-server 贡献代码，您需要设置本地开发环境

1. Fork 仓库：创建您自己的 code-server 仓库
2. 克隆您的 fork：git clone https://github.com/YOUR-USERNAME/code-server.git
3. 安装依赖项：遵循项目针对您平台的设置说明
4. 创建分支：为您的更改创建一个具有描述性名称的分支

进行更改和测试

在对代码库进行更改时

1. 遵循代码风格：与现有代码库保持一致
2. 添加测试：在适用时为您的更改包含测试
3. 运行现有测试：确保在提交更改之前所有测试都通过
4. 跨平台测试：如果可能，在多个平台（Linux、macOS、Windows）上测试您的更改

拉取请求流程

1. 创建 pull request：从您的分支向 code-server 主仓库提交 PR
2. 描述您的更改：清晰地描述您的更改内容和原因
3. 链接相关 issue：使用 GitHub issue 链接语法引用任何相关的 issue
4. CI 检查：确保所有持续集成检查都通过
5. 代码审查：及时处理审查者的反馈
6. 批准和合并：批准后，您的 PR 将被合并

发布流程

了解发布流程有助于贡献者知道他们的贡献何时以及如何包含在发布版本中。

项目维护三个发布环境

1. 生产环境：标记为 npm 上 latest 的稳定发布
2. 暂存环境：来自主分支的 beta 发布，标记为 npm 上 beta
3. 开发环境：用于测试的 PR 特定发布，使用 PR 号进行标记

来源：ci/steps/publish-npm.sh

社区与支持

对于不适合放入 issue 的问题和讨论

• GitHub Discussions：使用 GitHub Discussions 板块 进行提问和社区支持
• Slack：加入 code-server Slack 社区 进行实时讨论

来源：.github/ISSUE_TEMPLATE/config.yml

贡献文档

文档是项目的重要组成部分。对文档改进的贡献非常有价值

1. 识别改进领域：缺失信息、不清楚的解释或过时的内容
2. 提议更改：提交一个 issue 或 pull request，其中包含您建议的改进
3. 遵循文档指南：保持一致的风格和格式

Code-Server 系统和贡献机会

下图显示了 code-server 的主要组件，这些组件都欢迎贡献

来源：系统概述中的架构图

持续集成

所有 pull request 都需要经过 CI 检查，以确保代码质量和兼容性。CI 流水线

1. 运行单元和端到端测试
2. 为不同平台构建应用程序
3. 检查代码格式和 linting
4. 用于发布，将应用程序打包分发

了解此过程有助于确保您的贡献符合项目的质量标准。

来源：ci/lib.sh、ci/steps/publish-npm.sh

结论

为 code-server 做出贡献是一个协作过程。遵循这些指南，您可以帮助改进项目并确保您的贡献得到有效整合。请记住，所有贡献者都应遵守项目的行为准则，并维护一个尊重和包容的环境。

感谢您对为 code-server 做出贡献的兴趣！