Thanks for your interest in contributing! Here's how to get started.
- Fork and clone the repo
- Install in editable mode with test extras:
pip install -e ".[test]" - Copy
.env.exampleto.envand add your OpenAI API key - Run the tests:
pytest -q - Test the CLI:
secdd "What are the main risk factors in retail?"
- Bug fixes and improvements to filing parsing (
secdd/edgar.py) - Better prompts for specific filing types (
secdd/prompts.py) - CLI improvements (
secdd/cli.py) - Support for additional document types
- Performance optimizations
- New EDGAR form types and data sources
Check the Issues tab for open tasks.
- Create a branch from
main - Make your changes
- Test locally (both CLI and library usage if applicable)
- Submit a PR with a clear description of what changed and why
Keep PRs focused on a single change. If you're fixing a bug and also want to refactor nearby code, split them into separate PRs.
- Python: follow existing patterns in the codebase
- Use conventional commits (
feat:,fix:,docs:,refactor:) - No new dependencies without discussion in an issue first
Open an issue with:
- What you expected to happen
- What actually happened
- Steps to reproduce
- Your Python version and OS