Prompt Engineering项目贡献指南：如何为开源提示工程社区做出贡献
项目地址: https://gitcode.com/gh_mirrors/pr/Prompt_Engineering 欢迎来到全球最全面的Prompt Engineering技术资源库！🌟 这个开源项目汇集了从基础概念到高级策略的完整提示工程教程和实现，是学习如何与大语言模型有效沟通和利用的重要宝库。无论你是AI初学者还是资深从业者，这里都有适合你的学习资源。
🤝 为什么要参与贡献？
Prompt Engineering是人工智能领域的前沿技术，正在彻底改变我们与AI交互的方式。通过为这个项目贡献你的知识和经验，你将：
- 🎓 帮助更多人掌握提示工程的核心技能
- 🚀 推动AI提示技术的创新与发展
- 💡 与全球AI爱好者交流分享
- 📚 建立个人在AI社区的影响力
📋 多种贡献方式
我们欢迎各种形式的贡献！以下是你可以参与的方式：
🆕 添加新的提示工程技术
在 all_prompt_engineering_techniques 文件夹中创建新的Jupyter Notebook，展示创新的提示工程实现方法。
✨ 改进现有教程
完善、更新或扩展我们当前的教程内容，让学习体验更加顺畅。
🐛 修复问题和错误
帮助我们解决现有代码或解释中的问题，提升项目质量。
📖 优化文档和说明
提高文档的清晰度，添加更多示例，或修正拼写错误。
💬 参与社区讨论
在我们的Discord社区中分享创意想法，帮助塑造GenAI的未来。
🛠️ 具体贡献步骤
1. 准备开发环境
首先克隆仓库到本地：
git clone https://gitcode.com/gh_mirrors/pr/Prompt_Engineering
2. 创建分支和修改
- Fork仓库并从
main分支创建你的分支 - 按照项目的最佳实践进行修改
- 确保你的更改按预期工作
3. 提交和推送
- 编写信息明确且简洁的git提交
- 在打开pull request前，确保你的代码与当前main分支同步且没有冲突
4. 发起Pull Request
将代码推送到你的fork并提交pull request
📝 添加新技术的最佳实践
当你向仓库添加新的提示工程技术时，请遵循以下步骤：
创建笔记本文件
在 all_prompt_engineering_techniques 文件夹中创建新的Jupyter Notebook。
更新README文档
- 在README的适当类别中添加你的新技术
- 根据复杂度和类型将其放置在合适的分类中
- 更新后续技术的编号以保持正确顺序
笔记本结构规范
为了确保所有笔记本的一致性和可读性：
- 标题和概述 - 清晰的标题和提示工程技术的简要概述
- 详细解释 - 涵盖动机、关键组件、技术架构和结论
- 实现步骤 - 带有清晰注释和解释的分步实现
- 使用示例 - 通过实际示例展示技术
- 额外考虑 - 讨论局限性、潜在改进或特定用例
🎯 代码质量和可读性
为确保我们代码的最高质量和可读性：
编写清晰代码
遵循编写清晰、可读代码的最佳实践。
添加注释
添加清晰简洁的注释来解释复杂逻辑。
格式化代码
在你的贡献中保持一致的格式。
🌟 加入我们的社区
我们拥有一个充满活力的Discord社区，贡献者可以在那里讨论想法、提出问题并就GenAI主题进行协作。
记住，没有贡献是太小而不重要的。每一个改进都有助于使这个仓库成为社区更好的资源。
让我们汇集我们的集体知识和创造力，共同推动提示工程技术的发展！
快乐贡献！🚀
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
