Contributing
Calor is an experiment in language design for AI agents. We welcome contributions from the community.
Ways to Contribute
| Area | Description | Skill Level |
|---|---|---|
| Benchmark Programs | Add new Calor/C# program pairs | Beginner |
| Documentation | Improve docs, add examples | Beginner |
| Bug Reports | Report compiler issues | Beginner |
| Metric Refinements | Improve evaluation metrics | Intermediate |
| Parser Improvements | Fix or extend Calor parsing | Intermediate |
| Code Generation | Improve C# output quality | Advanced |
| New Features | Add language features | Advanced |
Getting Started
- Fork the repository on GitHub
- Clone your fork locally
- Set up the development environment (see Development Setup)
- Make your changes on a feature branch
- Run tests to ensure nothing is broken
- Submit a pull request
Contribution Guidelines
Code Style
- Follow existing code patterns
- Use meaningful names
- Add comments for complex logic
- Keep functions focused
Commits
- Write clear commit messages
- One logical change per commit
- Reference issues when applicable
Pull Requests
- Describe what the PR does
- Include test coverage for new features
- Update documentation if needed
Priority Areas
We're especially interested in contributions to:
1. Benchmark Corpus
The evaluation framework needs more programs:
- Different problem domains
- Varying complexity levels
- Edge cases for metrics
See Adding Benchmarks.
2. Documentation
- More code examples
- Tutorial content
- API documentation
3. Parser Edge Cases
The Calor parser needs testing with:
- Complex nested structures
- Edge case syntax
- Error recovery scenarios
Quick Links
- Development Setup - Set up your environment
- Adding Benchmarks - Add evaluation programs
- GitHub Repository - Source code
- Issues - Bug reports and feature requests
Questions?
Open an issue on GitHub if you have questions about contributing.