菜单

贡献指南

相关源文件

本文档介绍了如何为 LeetCode 解决方案仓库做贡献。它概述了提交内容到项目的标准、流程和最佳实践,以确保所有贡献的一致性和质量。

有关 91 天算法计划的信息,请参阅 91 天算法计划

贡献类型

本仓库接受多种类型的贡献:

来源:README.md614-618 daily/README.md1-20

贡献流程

常规 Pull Request 流程

来源:README.md614-618 daily/README.md1-20

每日一题贡献流程

关于“每日一题”的贡献

  1. 请访问 项目看板 查看可用题目。
  2. 选择你感兴趣的题目。
  3. 在该题目的 Issue 下评论“认领”。
  4. 维护者将把你分配为解决者,并将 Issue 移至“进行中”状态。
  5. 按照模板格式化你的解决方案。
  6. 提交一个包含你解决方案的 PR。
  7. 合并后,你将成为项目的贡献者。

来源:daily/README.md1-23

解决方案格式要求

所有问题解决方案都必须遵循标准化格式,以保持一致性。以下是解决方案文件的要求结构:

必需部分

章节描述
标题问题编号和名称(例如,“518. 零钱兑换 2”)
问题描述问题陈述副本
先决知识必需概念和算法
公司使用过此问题的公司(如果已知)
方法解决方案方法说明
关键点重要见解和技巧
代码一种或多种语言的实现
复杂度分析时间和空间复杂度

来源:templates/problems/1014.best-sightseeing-pair.md1-64

代码格式化

代码块必须明确指定语言格式。

JavaScript 代码

C++ 代码

Java 代码


If you provide multiple language implementations, clearly label each one.

Sources: <FileRef file-url="https://github.com/azl397985856/leetcode/blob/4183cbac/templates/problems/1014.best-sightseeing-pair.md#L35-L64" min=35 max=64 file-path="templates/problems/1014.best-sightseeing-pair.md">Hii</FileRef>

### Daily Question Format

Daily questions have a specific format that includes:

```mermaid
graph TD
    DailyQuestionMD["Daily Question Markdown"] --> InfoCard["Information Card 
    - Date
    - Problem Link
    - Tags"]
    
    DailyQuestionMD --> ProblemDescription["Problem Description"]
    DailyQuestionMD --> ReferenceAnswer["Reference Answer
    - Approach
    - Code
    - Complexity Analysis"]
    
    DailyQuestionMD --> AlternativeSolutions["Alternative Solutions
    (Optional)"]

来源:daily/README.md21-23 daily/2019-06-14.md1-159 daily/2019-10-11.md1-100

解决方案贡献工作流

贡献问题解决方案时,请遵循以下步骤:

来源:README.md614-618 templates/problems/1014.best-sightseeing-pair.md1-64

图片和图表指南

对于需要视觉解释的复杂问题

  1. 创建清晰的图表来说明方法。
  2. 将图表源文件存储在 ./assets/drawio/
  3. 使用 draw.io 编辑图表。
  4. 在你的解决方案中适当引用图表。

来源:README.md618-619

最佳实践

为确保您的贡献被接受

  1. 严格遵循模板结构。
  2. 提供清晰的解释,并包含适当的细节。
  3. 为所有解决方案提供复杂度分析。
  4. 使用一致的代码块格式。
  5. 提交前测试您的代码。
  6. 对于中文解决方案,提供 LeetCode 中国的链接。
  7. 对于英文解决方案,提供全球 LeetCode 的链接。

应避免的常见问题

  1. 模板中缺少必需的部分。
  2. 对方法的解释不清楚。
  3. 代码格式不正确。
  4. 复杂度分析不足。
  5. 解决方案未引用先决知识。
  6. 视觉解释的图表质量差。

来源:templates/problems/1014.best-sightseeing-pair.md1-64 README.md614-619

通过遵循这些贡献指南,您将有助于维护仓库的质量和一致性,使其成为算法学习和技术面试准备者的宝贵资源。