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

张开发
2026/4/9 23:30:10 15 分钟阅读

分享文章

andrej-karpathy-skills项目贡献指南:如何参与开发
andrej-karpathy-skills项目贡献指南如何参与开发【免费下载链接】andrej-karpathy-skills项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skillsandrej-karpathy-skills项目是基于Andrej Karpathy的观察和研究开发的LLM编码行为指南旨在帮助开发者减少常见的LLM编码错误提升代码质量和开发效率。本文将为你详细介绍如何参与该项目的开发与贡献。项目简介了解andrej-karpathy-skillsandrej-karpathy-skills项目核心是通过一套行为准则来优化LLM的编码行为。项目主要解决了LLM在编码过程中容易出现的错误假设、过度复杂化代码、不必要的代码修改以及缺乏明确目标等问题。项目包含四个关键原则这些原则被详细记录在项目文件中README.md项目的主要文档介绍了问题、解决方案、四大原则、安装方法等内容CLAUDE.md行为准则的核心文件详细列出了四大原则的具体内容skills/karpathy-guidelines/SKILL.md技能定义文件描述了如何应用这些准则贡献前准备环境搭建与学习1. 克隆项目仓库首先你需要将项目仓库克隆到本地git clone https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills2. 理解四大核心原则在开始贡献前务必熟悉项目的四大核心原则这是项目的基石思考先行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将你的修改推送到你的分支在PR描述中清晰说明修改的内容和目的说明你的修改如何符合项目的四大原则等待项目维护者的审核和反馈贡献最佳实践遵循项目原则应用思考先行原则在提交贡献前明确陈述你的假设和目标。例如如果你要添加一个新功能说明为什么这个功能是必要的以及它如何符合项目的整体目标。应用简洁至上原则确保你的贡献没有添加不必要的复杂性。检查你的代码或文档问自己这是否是解决问题的最简单方法如果不是尝试简化。应用精准修改原则在修改现有文件时只更改与你的贡献直接相关的部分。避免进行无关的改进或格式化修改除非这是你贡献的明确目标。应用目标驱动执行原则为你的贡献设定明确的成功标准。例如添加一个新的示例来说明简洁至上原则确保示例符合原则的要求并且能帮助用户理解如何应用该原则。贡献者注意事项项目采用MIT许可证你的贡献将遵循相同的许可证所有贡献都需要经过审核以确保它们符合项目的原则和质量标准如果你不确定如何开始可以先查看项目中的EXAMPLES.md了解示例用法记住项目的目标是减少LLM编码错误所以你的贡献应该有助于实现这一目标通过遵循这些指南你可以为andrej-karpathy-skills项目做出有价值的贡献帮助改进LLM的编码行为使其更加高效和可靠。无论你是经验丰富的开发者还是刚入门的新手你的参与都将对项目产生积极影响【免费下载链接】andrej-karpathy-skills项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

更多文章