datafusion-contrib / datafusion-contrib/orc-rust
Add CLAUDE.md file for AI agent development guidelines
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 30
- Forks
- 26
- Avg merge
- 19m
- Merged PRs (30d)
- 3
Description
Many modern Rust projects are adopting AI-assisted development tools (like Claude, GitHub Copilot, etc.) to improve developer productivity. To help these AI agents better understand project structure, coding standards, and development workflows, some projects have created dedicated guideline files.
Reference: The Vortex project has implemented a similar approach with their CLAUDE.md file, which serves as a good example of how such guidelines can be structured.
These files serve as a structured knowledge base that helps AI tools:
- Understand project architecture and module organization
- Follow consistent coding style and patterns
- Know where to place tests and how to structure them
- Understand domain-specific concepts (ORC format, Arrow integration, etc.)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository structure, Rust coding conventions, test organization, and the referenced Vortex CLAUDE.md example. Add a root CLAUDE.md covering project architecture, module organization, coding standards, testing workflows, and ORC and Arrow concepts; done means the file gives AI agents this project-specific guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100