kevinjqliu commented on code in PR #3638:
URL: https://github.com/apache/iceberg-rust/pull/3638#discussion_r4495665960
##########
AGENTS.md:
##########
@@ -51,6 +51,22 @@ the code they describe or they are wrong.
`make generate-public-api` to update each crate's `public-api.txt`, and
check its diff for API growth.
+## Public API
Review Comment:
i see we already mention this in the lines above
> - Use the narrowest visibility that works. Make items `pub` only when they
are part of the API the change intends to expose. Run
`make generate-public-api` to update each crate's `public-api.txt`, and
check its diff for API growth.
##########
AGENTS.md:
##########
@@ -51,6 +51,22 @@ the code they describe or they are wrong.
`make generate-public-api` to update each crate's `public-api.txt`, and
check its diff for API growth.
+## Public API
Review Comment:
should we also mention
https://github.com/apache/iceberg-rust/blob/main/crates/iceberg/public-api.txt
? which is used to show diffs on prs regarding public api changes
##########
AGENTS.md:
##########
@@ -51,6 +51,22 @@ the code they describe or they are wrong.
`make generate-public-api` to update each crate's `public-api.txt`, and
check its diff for API growth.
+## Public API
Review Comment:
should we be prescriptive here? or just mention something like "evaluate if
the api needs to be public and whether it matches existing abstractions. must
justify its existence to add a public api"
idk if this helps, this is just the way I talk to my agent 🤷
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
