markhoerth commented on code in PR #11205: URL: https://github.com/apache/gravitino/pull/11205#discussion_r3299289119
########## docs/STYLE.md: ########## @@ -0,0 +1,217 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Documentation Style Guide for Apache Gravitino + +Style and review guidance for human and AI contributors editing Gravitino documentation, log messages, exception messages, and configuration descriptions. When reviewing existing text, propose edits one at a time, tag each with a category, and make no changes without explicit approval. Review Comment: Good question, and thanks for flagging. Adding a STYLE.md reference to AGENTS.md is the right end-state. I'd like to sequence it as a follow-up PR rather than fold it in here, for two reasons: 1. STYLE.md originally claimed scope over "documentation, log messages, exception messages, and configuration descriptions," but only the docs portion has been swept. I narrowed STYLE.md in c50910d8e to docs-only (removed the log/exception language from the opening scope statement and dropped the dedicated H2 section). An AGENTS.md reference can now point cleanly at a docs-scoped guide. 2. The docs tree itself isn't fully STYLE.md-compliant until my second polish-prose follow-up PR lands (per-file prose rewrites that need editorial judgment beyond mechanical sweeps). Canonicalizing STYLE.md in AGENTS.md before the tree complies would invite more changes before the docs are fully ready. I have the second branch ready and will send the second PR after we finish this one. I'll land the AGENTS.md update as a small follow-up after polish-prose merges. -- 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]
