imbajin commented on code in PR #3197: URL: https://github.com/apache/hugegraph/pull/3197#discussion_r4037499610
########## .github/PULL_REQUEST_TEMPLATE.md: ########## @@ -65,3 +65,5 @@ For example: - [ ] `Doc - TODO` <!-- Your PR changes impact docs and you will update later --> - [ ] `Doc - Done` <!-- Related docs have been already added or updated --> - [ ] `Doc - No Need` <!-- Your PR changes don't impact/need docs --> + +Related hugegraph-doc PR or issue: <!-- required for Doc - TODO and Doc - Done --> Review Comment: Addressed in 899f0722c. The template now visibly asks contributors to select a status and provide the documentation location. In-repository files are accepted; a paired hugegraph-doc PR is needed only when website documentation is affected. ########## AGENTS.md: ########## @@ -101,6 +113,10 @@ Before writing new tests, check existing suites under `hugegraph-server/hugegrap and `install-dist/scripts/dependency/known-dependencies.txt`. - `hugegraph-commons` is shared by every module; `hugegraph-struct` must precede PD/Store; server backends depend on `hugegraph-core`. +- Feature, config and `Dockerfile` changes ship a paired PR in `apache/hugegraph-doc`. Review Comment: Addressed in 899f0722c. AGENTS.md, CONTRIBUTING.md and the template now agree: required docs must be ready before merge; in-repository docs ship in the same PR, affected website docs use a coordinated paired PR, and a follow-up issue alone is insufficient. TODO remains a pending state, not permission to defer beyond merge. ########## AGENTS.md: ########## @@ -101,6 +113,10 @@ Before writing new tests, check existing suites under `hugegraph-server/hugegrap and `install-dist/scripts/dependency/known-dependencies.txt`. - `hugegraph-commons` is shared by every module; `hugegraph-struct` must precede PD/Store; server backends depend on `hugegraph-core`. +- Feature, config and `Dockerfile` changes ship a paired PR in `apache/hugegraph-doc`. + Land both together; docs that trail the code go stale without anyone noticing. +- README: wrap at 120, keep it thin, push detail to hugegraph-doc, and fold the Review Comment: Addressed in 899f0722c. Removed the blanket README wrapping instruction. README remains a concise entry point; only two navigation descriptions were adjusted, without unrelated reflow. -- 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]
