Contributing new examples requires adherence to the following normalized process:
1. Preliminary preparations
- Fork main repository to personal GitHub account
- Create the feature branch locally:
git checkout -b feature-summarizer
2. Content development
- Create a new example folder under src/, keeping the same directory structure as the existing project
- Ensure that the minimum runnable unit is included:
- dataset/(sample data)
- program.py (main logic)
- signatures.py (signature definition)
- run.py (execution entry)
- Write README.md describing sample functions and usage
3. Submission for review
- fulfillment
git add . && git commit -m "feat: add summarizer example" - Push the branch and create a Pull Request
- Detailed in the PR description:
- Example application scenarios
- DSPy key technology points used
- Test validation status
It is recommended that you consult the repository CONTRIBUTING.md file prior to development for specific specifications such as code style and testing requirements.
This answer comes from the articleDSPy Examples: Practical examples demonstrating DSPy functionalityThe
May not be reproduced without permission:AI productivity tools " What process should I follow if I want to contribute new examples to the DSPy sample code base?
