Add project helpful info readme for AI Coding model#17229
Add project helpful info readme for AI Coding model#17229JackieTien97 wants to merge 5 commits intomasterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #17229 +/- ##
=========================================
Coverage 39.69% 39.69%
Complexity 282 282
=========================================
Files 5102 5102
Lines 342050 342050
Branches 43578 43578
=========================================
+ Hits 135775 135778 +3
+ Misses 206275 206272 -3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds contributor/agent-facing documentation at the repo root to consolidate project guidelines, Java style rules, and build/test commands, with a lightweight entrypoint file pointing to the main guidance.
Changes:
- Added
AGENTS.mddocumenting project overview, Java style rules (Spotless/Checkstyle), license headers, and common build/test commands. - Added
CLAUDE.mdcontaining the Apache license header and a pointer toAGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| CLAUDE.md | Adds a minimal pointer document directing readers to the main guidelines. |
| AGENTS.md | Introduces consolidated coding standards and build/test instructions for contributors/agents. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. **Star imports are forbidden**: Never use `import xxx.*` or `import static xxx.*`. Always list each required class or static member explicitly. | ||
| 2. **Import ordering** (enforced by Spotless): | ||
| ``` | ||
| org.apache.iotdb.* |
There was a problem hiding this comment.
This import-order example uses org.apache.iotdb.* in the diagram, which reads like a star import and conflicts with the earlier “Star imports are forbidden” rule. Consider changing the diagram to indicate “imports with prefix org.apache.iotdb” (without *) or otherwise clarifying it’s a grouping rule rather than a literal import statement.
| org.apache.iotdb.* | |
| Imports with prefix org.apache.iotdb |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
|
Please double-check if formally supporting agentic frameworks is not in contrast to current Apache policy. |
|
Actually, we are not the first Apache project to add these files. https://github.com/apache/spark |
|
Yeah ... so having had a look at the current policy, it should be ok ... it really depends on how AI is used by the committers/pmc members. But I'd like to point out: Just because other projects do somethings is not always proof that something's ok. Usually especially with new things arising, some projects just go ahead and then other projects treat that as proof, that it's ok and it's sometimes hard to catch this from a foundations perspective. If really adopting and embracing AI, possibly thinking about adopting SpecKit would be a good idea? (https://github.com/github/spec-kit) ... because the things you are telling the AI actually are also interesing for humans. So going a bit down the path of spec-driven development would have benefits for human contributors as well as AI ones. |
This pull request adds documentation files to clarify project guidelines, coding standards, and build/test procedures for contributors. The main changes are the introduction of
AGENTS.mdwith comprehensive rules andCLAUDE.mdas a pointer to those rules.Documentation additions:
AGENTS.md, which provides a detailed overview of the project, Java code style guide, naming conventions, code structure requirements, license header templates, verification and build commands, and instructions for running unit and integration tests.CLAUDE.md, which includes the standard license header and directs readers toAGENTS.mdfor all project guidelines and instructions.