Skip to content

doc(phyai): update code of conduct#39

Merged
chenghuaWang merged 2 commits into
MEmbodied:mainfrom
chenghuaWang:dev/chenghua
Jul 2, 2026
Merged

doc(phyai): update code of conduct#39
chenghuaWang merged 2 commits into
MEmbodied:mainfrom
chenghuaWang:dev/chenghua

Conversation

@chenghuaWang

@chenghuaWang chenghuaWang commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation

    • Added new code of conduct pages in both English and Chinese.
    • Updated the documentation navigation to surface the new pages.
  • Chores

    • Expanded spellcheck exclusions to cover documentation paths and additional file locations.
    • Refined code ownership rules for model, docs, examples, and benchmark directories.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a new bilingual Code of Conduct document (English and Chinese) under docs/developer_guide, wires it into navigation, expands CODEOWNERS with granular path rules for models/docs/examples/benchmark, and updates codespell configuration to exclude the docs/ directory.

Changes

Code of Conduct Documentation

Layer / File(s) Summary
English Code of Conduct content
docs/developer_guide/code-of-conduct.mdx
New page covering community pledge, encouraged/restricted behaviors, reporting process, enforcement ladder, scope, and attribution to Contributor Covenant v3.0.
Chinese Code of Conduct content
docs/zh/developer_guide/code-of-conduct.mdx
New translated page mirroring the English content and structure.
Navigation wiring
docs/docs.json
Adds "Developer guide" groups to English and Chinese navigation linking the new pages.
Codespell and CODEOWNERS updates
.codespellrc, .pre-commit-config.yaml, .github/CODEOWNERS
Excludes docs/ from codespell checks and expands CODEOWNERS with granular rules for model source directories, docs subpaths, examples, and benchmark scripts.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding and updating the code of conduct documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a Code of Conduct in both English and Chinese, registers it in the documentation configuration, excludes the docs directory from codespell checks, and updates the CODEOWNERS file with specific paths for models, documentation, examples, and benchmarks. The review feedback identifies two issues in the Chinese translation of the Code of Conduct: an incomplete sentence regarding how to report violations and an unnecessary markdown placeholder (****) that should be removed.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.


即使社区成员之间尽其所能地合作,也仍然可能发生矛盾。并不是所有冲突都涉及违反行为准则,本准则旨在强化受鼓励的行为与规范,它们有助于预防冲突并将伤害降到最低。

当事件发生时,及时报告非常重要。要报告可能的违规行为,**phyaiworker@agent.qq.com**。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The sentence is grammatically incomplete and missing the action verb (e.g., "请联系维护者" or "请发送邮件至"). It should be updated to match the English version: "To report a possible violation, contact the maintainers at phyaiworker@agent.qq.com."

当事件发生时,及时报告非常重要。要报告可能的违规行为,请联系维护者:**phyaiworker@agent.qq.com**。

Comment on lines +57 to +59

****

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The markdown bold/horizontal rule placeholder **** is unnecessary and does not exist in the English version. It should be removed.



@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/developer_guide/code-of-conduct.mdx`:
- Around line 62-63: The “Irresponsible communication” sentence in the code of
conduct reads awkwardly because “includes, links, or describes” is unclear.
Update that wording in the affected text to use “links to” instead of “links”
and tighten the phrase for smoother, more unambiguous reading while keeping the
meaning the same.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0de73e22-5900-4d90-916c-6b482d4d648c

📥 Commits

Reviewing files that changed from the base of the PR and between ae9594e and 86a9cb1.

📒 Files selected for processing (6)
  • .codespellrc
  • .github/CODEOWNERS
  • .pre-commit-config.yaml
  • docs/developer_guide/code-of-conduct.mdx
  • docs/docs.json
  • docs/zh/developer_guide/code-of-conduct.mdx

Comment on lines +62 to +63
4. Irresponsible communication. Failing to responsibly present content which includes, links, or describes any other
restricted behaviors.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Tighten this sentence for clarity.

“includes, links, or describes” reads awkwardly here; “links to” is clearer and less ambiguous.

Proposed fix
-4. Irresponsible communication. Failing to responsibly present content which includes, links, or describes any other restricted behaviors.
+4. Irresponsible communication. Failing to responsibly present content which includes, links to, or describes any other restricted behaviors.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
4. Irresponsible communication. Failing to responsibly present content which includes, links, or describes any other
restricted behaviors.
4. Irresponsible communication. Failing to responsibly present content which includes, links to, or describes any other
restricted behaviors.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/developer_guide/code-of-conduct.mdx` around lines 62 - 63, The
“Irresponsible communication” sentence in the code of conduct reads awkwardly
because “includes, links, or describes” is unclear. Update that wording in the
affected text to use “links to” instead of “links” and tighten the phrase for
smoother, more unambiguous reading while keeping the meaning the same.

Comment on lines +58 to +60
****

若社区管理员经调查确认存在违反此行为准则的行为,将参照以下"分级处理"机制,根据事件对相关人员及社区整体造成的影响程度,确定最适宜的伤害弥补方案。根据违规严重程度,可跳过较低级别的处理措施。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Remove the stray Markdown marker.

**** is malformed and will render oddly on the page. Delete it unless you intended a divider.

Proposed fix
 ## 处理与弥补伤害
-
-****
 
 若社区管理员经调查确认存在违反此行为准则的行为,将参照以下"分级处理"机制,根据事件对相关人员及社区整体造成的影响程度,确定最适宜的伤害弥补方案。根据违规严重程度,可跳过较低级别的处理措施。
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
****
若社区管理员经调查确认存在违反此行为准则的行为,将参照以下"分级处理"机制,根据事件对相关人员及社区整体造成的影响程度,确定最适宜的伤害弥补方案。根据违规严重程度,可跳过较低级别的处理措施。
若社区管理员经调查确认存在违反此行为准则的行为,将参照以下"分级处理"机制,根据事件对相关人员及社区整体造成的影响程度,确定最适宜的伤害弥补方案。根据违规严重程度,可跳过较低级别的处理措施。

@chenghuaWang chenghuaWang merged commit 1644b93 into MEmbodied:main Jul 2, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant