Skip to content

docs: clarify build and contribution conventions for agents #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zhjwpku wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −0
Open

docs: clarify build and contribution conventions for agents #910

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e21bd3d
docs: clarify build and contribution conventions for agents
zhjwpku Sep 5, 2026
b7c4cec
remove useless agent instruction
zhjwpku Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,17 @@ When assessing potential vulnerabilities or calibrating automated security
findings, use [`SECURITY-THREAT-MODEL.md`](SECURITY-THREAT-MODEL.md) as the
authoritative detailed description of this repository's security boundaries,
trust assumptions, and non-boundaries.

## Build System Consistency

Keep CMake and Meson build definitions in sync. When adding, removing, or
renaming source files, headers, tests, or build targets, or changing dependencies
or build options, update the corresponding CMake (`CMakeLists.txt` and CMake
modules) and Meson (`meson.build` and `meson.options`) definitions in the same
change.

## PR & Commit Conventions

- Use Conventional Commits for commit messages.
- Commit messages describe the what and why, not implementation details.

@wgtmac wgtmac Sep 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend keeping PR title and description in sync with latest commit. And then we can directly use those to be the final git commit message.

@zhjwpku zhjwpku Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line comes from https://github.com/apache/iceberg/blob/main/AGENTS.md?plain=1#L169, I'm not sure how can the AI coding tools know which is the latest commit, there can be other comments to be addressed after the latest commit.

@manuzhang manuzhang Sep 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @wgtmac's concern is that PR title and description could be out of sync when the PR contents are updated based on reviews. On the other hand, I'm not worried about Commit message itself, where AI has always done a good job in describing what and why.

@zhjwpku zhjwpku Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I agree that the PR title and description can get out of sync, but I'm not sure how we could reliably instruct the agent to update them once the PR is ready to merge. I think that's a point where human review is still necessary.

I will delete this one since llm should be trained to do a good job.

Comment thread
zhjwpku marked this conversation as resolved.
Outdated
- Run `pre-commit` for every PR and fix any reported issues.

@wgtmac wgtmac Sep 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is enforced by ci so we don't need to mention it?

@zhjwpku zhjwpku Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this is enforced by ci, but I think it would be great if the agent can run pre-commit locally before creating the PR.

@zhjwpku zhjwpku Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the agent is capable enough to detect .pre-commit-config.yaml and run the pre-commit automatically. If you still think this is unnecessary, I'll remove it.

@manuzhang manuzhang Sep 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the agent is capable enough to detect .pre-commit-config.yaml and run the pre-commit automatically.

no, it doesn't. My PR often fails due to pre-commit CI failure.

Loading