You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by "terrymanu (via GitHub)" <gi...@apache.org> on 2026/06/24 13:09:36 UTC
[PR] Strengthen coding rules for agents and Javadocs [shardingsphere]
terrymanu opened a new pull request, #38905:
URL: https://github.com/apache/shardingsphere/pull/38905
- Avoid test-only production constructors and constructor visibility changes
- Prefer ShardingSpherePreconditions for production guard failures
- Require least-specific collection declarations and avoid defensive collection re-wrapping
- Disallow default constructor Javadocs in code conduct and community docs
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Strengthen coding rules for agents and Javadocs [shardingsphere]
Posted by "terrymanu (via GitHub)" <gi...@apache.org>.
terrymanu merged PR #38905:
URL: https://github.com/apache/shardingsphere/pull/38905
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Strengthen coding rules for agents and Javadocs [shardingsphere]
Posted by "terrymanu (via GitHub)" <gi...@apache.org>.
terrymanu commented on PR #38905:
URL: https://github.com/apache/shardingsphere/pull/38905#issuecomment-4789770572
### Summary
**Review Result: Mergeable**
Reason: This PR is documentation / agent-guidance only, and the changed scope matches the stated intent: strengthening agent coding rules and synchronizing constructor Javadoc guidance into the community code-conduct docs. I did not find a blocker in the latest PR head.
### Evidence
- `AGENTS.md` adds agent-only rules for avoiding test-only production constructors, preferring `ShardingSpherePreconditions` for production guard failures, using least-specific collection declarations, and avoiding defensive collection re-wrapping. These rules stay within the AI development guide and do not change runtime code or public APIs.
- `CODE_OF_CONDUCT.md`, `docs/community/content/involved/conduct/code.en.md`, and `docs/community/content/involved/conduct/code.cn.md` all add the constructor Javadoc rule in the comments/logging standards section, keeping the root coding standard and community docs aligned.
- No production code, tests, build configuration, dependencies, distribution files, release artifacts, or generated resources are changed.
- GitHub check-runs for latest head `2b6f4b81a902592e1a1c0c363a954a9f1ef73713` show success for Check - Spotless, Check - CheckStyle, and Check - License.
- I noticed the new constructor Javadoc sentence is long in the Markdown files, but the repository rule there is phrased for code lines, and the declared formatting/style gates passed, so I am not treating it as a merge blocker.
### Review Details
- Reviewed Scope: `AGENTS.md`, `CODE_OF_CONDUCT.md`, `docs/community/content/involved/conduct/code.cn.md`, `docs/community/content/involved/conduct/code.en.md`; latest PR head `2b6f4b81a902592e1a1c0c363a954a9f1ef73713`; local merge-base `c18eec4fc27a7dfef3754c6ca1fe0e2c87db9861`; local triple-dot file list matched GitHub `/pulls/38905/files`.
- Not Reviewed Scope: no production runtime paths, tests, parser grammar, protocol behavior, packaging, dependency, or release artifacts were changed.
- Verification: `git diff --name-status <merge-base>..refs/remotes/pr/38905` matched GitHub file scope; `git diff --check <merge-base>..refs/remotes/pr/38905 -- <changed files>` exited 0; review inventory script exited 0; GitHub check-runs for Spotless, CheckStyle, and License completed successfully. Local Maven was not rerun because CI already verified the relevant style/license gates and the PR only changes documentation/agent guidance.
- Release Note / User Docs: release note not required because this is contributor/agent guidance only. Community code-conduct docs were updated in both English and Chinese.
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org