贡献新示例需要遵守以下规范化流程:
1. 前期准备
- Fork主仓库到个人GitHub账号
- 本地创建特性分支:
git checkout -b feature-summarizer
2. 内容开发
- 在src/下新建示例文件夹,保持与现有项目相同的目录结构
- 确保包含最小可运行单元:
- dataset/(样本数据)
- program.py(主逻辑)
- signatures.py(签名定义)
- run.py(执行入口)
- 编写README.md说明示例功能和用法
3. 提交审核
- 执行
git add . && git commit -m "feat: add summarizer example"
- 推送分支并创建Pull Request
- 在PR描述中详细说明:
- 示例的应用场景
- 使用的DSPy关键技术点
- 测试验证情况
建议在开发前先查阅仓库CONTRIBUTING.md文件,了解代码风格和测试要求等具体规范。
本答案来源于文章《DSPy Examples:展示DSPy功能的实用示例》