andrej-karpathy-skills项目贡献指南：如何参与开发

andrej-karpathy-skills项目贡献指南：如何参与开发

【免费下载链接】andrej-karpathy-skills项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills

andrej-karpathy-skills项目是基于Andrej Karpathy的观察和研究开发的LLM编码行为指南，旨在帮助开发者减少常见的LLM编码错误，提升代码质量和开发效率。本文将为你详细介绍如何参与该项目的开发与贡献。

项目简介：了解andrej-karpathy-skills

andrej-karpathy-skills项目核心是通过一套行为准则来优化LLM的编码行为。项目主要解决了LLM在编码过程中容易出现的错误假设、过度复杂化代码、不必要的代码修改以及缺乏明确目标等问题。

项目包含四个关键原则，这些原则被详细记录在项目文件中：

• README.md：项目的主要文档，介绍了问题、解决方案、四大原则、安装方法等内容
• CLAUDE.md：行为准则的核心文件，详细列出了四大原则的具体内容
• skills/karpathy-guidelines/SKILL.md：技能定义文件，描述了如何应用这些准则

贡献前准备：环境搭建与学习

1. 克隆项目仓库

首先，你需要将项目仓库克隆到本地：

git clone https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills

2. 理解四大核心原则

在开始贡献前，务必熟悉项目的四大核心原则，这是项目的基石：

思考先行（Think Before Coding）

不要做假设，不要隐藏困惑，要明确权衡取舍。在实现前，明确陈述假设，提出多种解释，在有更简单方法时勇于提出，遇到不清楚的地方及时提问。

简洁至上（Simplicity First）

用最少的代码解决问题，不做推测性的实现。不添加未要求的功能，不为单一用途的代码创建抽象，不做不必要的"灵活性"或"可配置性"设计，不为不可能的场景添加错误处理。

精准修改（Surgical Changes）

只修改必须修改的部分，只清理自己造成的混乱。编辑现有代码时，不"改进"相邻代码、注释或格式，不重构未损坏的部分，匹配现有风格，发现不相关的死代码时只提及不删除。

目标驱动执行（Goal-Driven Execution）

定义成功标准，循环直到验证通过。将任务转换为可验证的目标，如"添加验证"变为"编写无效输入的测试，然后使其通过"，多步骤任务要制定简要计划。

贡献步骤：从发现问题到提交PR

发现问题或提出改进

如果你发现项目存在问题，或者有改进建议，可以通过以下方式提出：

• 检查现有文档，如README.md和CLAUDE.md，确认问题或建议是否已有相关内容
• 思考你的建议如何符合项目的四大原则
• 准备清晰的描述，说明问题所在或改进的具体内容

编写代码或修改文档

当你准备进行代码编写或文档修改时，请遵循以下准则：

代码贡献

• 遵循"简洁至上"原则，确保代码简洁高效
• 遵循"精准修改"原则，只修改必要的部分
• 确保你的代码符合项目的风格和规范
• 为你的代码添加清晰的注释

文档贡献

• 确保文档内容准确反映项目的功能和使用方法
• 保持文档的简洁性和可读性
• 在修改CLAUDE.md或skills/karpathy-guidelines/SKILL.md时，确保修改符合四大原则的核心思想

提交Pull Request

完成修改后，你可以提交Pull Request：

1. 将你的修改推送到你的分支
2. 在PR描述中清晰说明修改的内容和目的
3. 说明你的修改如何符合项目的四大原则
4. 等待项目维护者的审核和反馈

贡献最佳实践：遵循项目原则

应用"思考先行"原则

在提交贡献前，明确陈述你的假设和目标。例如，如果你要添加一个新功能，说明为什么这个功能是必要的，以及它如何符合项目的整体目标。

应用"简洁至上"原则

确保你的贡献没有添加不必要的复杂性。检查你的代码或文档，问自己："这是否是解决问题的最简单方法？"如果不是，尝试简化。

应用"精准修改"原则

在修改现有文件时，只更改与你的贡献直接相关的部分。避免进行无关的"改进"或格式化修改，除非这是你贡献的明确目标。

应用"目标驱动执行"原则

为你的贡献设定明确的成功标准。例如，"添加一个新的示例来说明'简洁至上'原则，确保示例符合原则的要求，并且能帮助用户理解如何应用该原则"。

贡献者注意事项

• 项目采用MIT许可证，你的贡献将遵循相同的许可证
• 所有贡献都需要经过审核，以确保它们符合项目的原则和质量标准
• 如果你不确定如何开始，可以先查看项目中的EXAMPLES.md，了解示例用法
• 记住，项目的目标是减少LLM编码错误，所以你的贡献应该有助于实现这一目标

通过遵循这些指南，你可以为andrej-karpathy-skills项目做出有价值的贡献，帮助改进LLM的编码行为，使其更加高效和可靠。无论你是经验丰富的开发者还是刚入门的新手，你的参与都将对项目产生积极影响！

【免费下载链接】andrej-karpathy-skills项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills