mchades commented on code in PR #11205: URL: https://github.com/apache/gravitino/pull/11205#discussion_r3301305194
########## 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: Would it be better to create a skill similar to `gravitino-docs-refine` in the `.claude/skills` directory for maintaining both `STYLE.md` and `scripts`? This approach would allow the current `docs` to focus solely on user-facing documentation for Gravitino, thereby distinguishing it from developer-facing documentation standards and coding agent guidelines. Additionally, if the content of `scripts` is confirmed to be accurate, we can also include it in the build CI's step, so that the validation script will run automatically when the content in the `docs` directory of the PR is changed. WDYT? @jerryshao -- 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]
