Contributing to CoDA-Bench
June 8, 2026 ยท View on GitHub
Thank you for your interest in contributing to CoDA-Bench! We welcome contributions from the community.
Ways to Contribute
๐ Reporting Bugs
- Check if the issue already exists in GitHub Issues
- Use the bug report template
- Include reproducible examples and error messages
๐ก Suggesting Enhancements
- Open an issue with the "enhancement" label
- Clearly describe the proposed feature and its benefits
- Discuss implementation approaches
๐ Improving Documentation
- Fix typos, clarify instructions, add examples
- Update outdated information
- Translate documentation to other languages
๐งช Adding Baseline Agents
- Implement your agent following the evaluation protocol
- Include clear setup instructions
- Share results and analysis
๐ Sharing Results
- Submit evaluation results to the leaderboard
- Share interesting findings or error analysis
- Contribute trajectory logs for research
Development Setup
-
Fork the repository
-
Clone your fork:
git clone https://github.com/YOUR_USERNAME/CoDA-Bench.git cd CoDA-Bench -
Create a virtual environment:
python -m venv .venv source .venv/bin/activate # On Windows: .venv\Scripts\activate -
Install in development mode:
pip install -e ".[dev]" -
Create a branch:
git checkout -b feature/your-feature-name
Code Quality
Style Guide
- Follow PEP 8 for Python code
- Use type hints where appropriate
- Write docstrings for functions and classes
Linting and Formatting
# Format code
ruff format .
# Check for issues
ruff check .
# Type checking
mypy coda_bench/
Testing
# Run all tests
pytest
# Run with coverage
pytest --cov=coda_bench
Pull Request Process
-
Update documentation if you change functionality
-
Add tests for new features
-
Ensure tests pass and code is formatted
-
Write clear commit messages:
feat: Add support for custom metrics fix: Correct numeric matching tolerance docs: Update evaluation protocol -
Submit PR with:
- Clear description of changes
- Link to related issues
- Screenshots/examples if applicable
-
Address review feedback promptly
Leaderboard Submissions
To submit results to the leaderboard:
-
Run evaluation on both full and hard subsets
-
Create a JSON file with your results:
{ "method": "YourAgent-v1", "model": "GPT-5.5", "ea_full": 0.611, "ea_hard": 0.496, "da_full": 0.523, "da_hard": 0.487, "metadata": { "date": "2026-06-08", "contact": "your@email.com", "paper": "https://arxiv.org/abs/xxxx.xxxxx", "code": "https://github.com/yourorg/youragent" } } -
Submit via:
- GitHub PR to
leaderboard/submissions/ - Leaderboard form
- GitHub PR to
Code of Conduct
We are committed to providing a welcoming and inclusive environment. Please:
- Be respectful and constructive
- Welcome newcomers
- Focus on what is best for the community
- Show empathy towards others
Questions?
- Open a GitHub Discussion
- Email: zhangshaolei98@ruc.edu.cn
Thank you for contributing to CoDA-Bench! ๐