GitHub user soumilshah1995 created a discussion: Making Hudi Github Project More Agentic
Hi everyone — I had a small proposal that could help make our open-source GitHub repos much more **AI-agent friendly** and easier to maintain. **Idea: introduce a few lightweight repo conventions so AI agents understand the project better and can contribute safely.** **A. `AGENTS.md`** A file that explains the repository structure, coding conventions, and important modules so AI agents understand how the project is organized before making changes. **B. `ARCHITECTURE.md`** A high-level overview of the system architecture, key components, and data flow. This helps agents reason about design decisions instead of only reading code. **C. Documentation Skill (AI-based)** Introduce an automated documentation workflow where an AI agent periodically scans the repo and generates or updates documentation for APIs, modules, and examples. This could help keep open-source documentation consistently up to date. **Goal:** Make the repo easier for both humans and AI agents to understand, improve onboarding, and enable more reliable automated contributions. Happy to experiment with a small prototype if folks think this could be useful. GitHub link: https://github.com/apache/hudi/discussions/18324 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
