Skip to content

docs: add Simplified Chinese contributing and security guides - #1964

Open
VhahahaV wants to merge 2 commits into
UNIkeEN:mainfrom
VhahahaV:docs/add-zh-hans-contributing-security
Open

VhahahaV wants to merge 2 commits into
UNIkeEN:mainfrom
VhahahaV:docs/add-zh-hans-contributing-security

Conversation

@VhahahaV

@VhahahaV VhahahaV commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

Checklist

  • Changes have been tested locally and work as expected.
  • All tests in workflows pass successfully.
  • Documentation has been updated if necessary.
  • Code formatting and commit messages align with the project's conventions.
  • Comments have been added for any complex logic or functionality if possible.

This PR is a ..

  • 🌐 Internationalization
  • 📄 Documentation improvement

Related Issues

N/A — no linked issue.

Description

Add Simplified Chinese versions of the contributing guide and security policy under docs/, following the localization layout established by the Code of Conduct.

The English and Simplified Chinese documents now provide bidirectional language links. The translations keep the development commands, version requirements, contribution rules, supported-version table, vulnerability reporting channel, and response-time expectations aligned with the English originals.

Additional Context

No runtime code is changed. The new documents pass Prettier validation, and their headings, code blocks, tables, relative links, and technical literals were checked against the English originals.

Summary by Sourcery

Provide localized Simplified Chinese contribution and security guidance while keeping the English documentation aligned.

Documentation:

  • Add Simplified Chinese versions of the contributing guide and security policy.
  • Add bidirectional language links between the English and Simplified Chinese documentation.

Copilot AI lite review requested due to automatic review settings September 15, 2026 03:14
@sourcery-ai

sourcery-ai Bot commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Adds Simplified Chinese contributing and security guides under docs/, translates the original project guidance without changing runtime code, and adds bidirectional language links between English and Chinese versions.

File-Level Changes

Change Details Files
Add a Simplified Chinese localization of the contributing guide while preserving the English guide’s project-specific instructions and technical details.
  • Translate contribution rules, development setup, commands, formatting checks, build workflow, and collaborator guidance.
  • Link the localized Code of Conduct and retain relevant external and mailto links.
docs/CONTRIBUTING.zh-Hans.md
Add a Simplified Chinese localization of the security policy with equivalent reporting and support information.
  • Translate supported versions, vulnerability reporting instructions, response expectations, and follow-up process.
  • Preserve the security email, subject prefix, and supported-version table.
docs/SECURITY.zh-Hans.md
Add bidirectional language navigation between the English and Simplified Chinese documentation.
  • Add Simplified Chinese links to the English contributing and security documents.
  • Add English links to both localized documents.
CONTRIBUTING.md
SECURITY.md
docs/CONTRIBUTING.zh-Hans.md
docs/SECURITY.zh-Hans.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 15, 2026

@sourcery-ai sourcery-ai 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.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/CONTRIBUTING.zh-Hans.md" line_range="80-81" />
<code_context>
+pnpm eslint "src/**/*.{js,jsx,ts,tsx}" --fix       # 修复
+
+# 后端部分(Linux、macOS 或 Windows 上的 Git Bash)
+rustfmt --check src-tauri/src/**/*.rs              # 检查
+rustfmt src-tauri/src/**/*.rs                      # 修复
+
+# 后端部分(Windows PowerShell)
</code_context>
<issue_to_address>
**nitpick:** The manual Rust formatting commands only target `src-tauri/src/**/*.rs` and omit the repository's backend files under `src-tauri/crates/**/*.rs` and `src-tauri/build.rs`, so contributors following this guide can report a clean format check while those Rust files remain unformatted.

**Triggers:** When contributors use the manual formatting commands instead of `pnpm lint-staged`.

**Suggested fix:** Use the repository-wide paths from `package.json` (including `src-tauri/crates/**/*.rs` and `src-tauri/build.rs`), or instruct contributors to run `cargo fmt --all -- --check` from `src-tauri`.

```suggestion
(cd src-tauri && cargo fmt --all -- --check)        # 检查
(cd src-tauri && cargo fmt --all)                  # 修复
```
</issue_to_address>

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/CONTRIBUTING.zh-Hans.md

Copilot AI 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.

🟡 Changes recommended

Correct the documented Bash glob and PowerShell formatting commands before approval.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds Simplified Chinese contributing and security guides with English/Chinese navigation links.

Changes:

  • Adds translated contributing and security documentation.
  • Preserves project requirements, commands, support versions, and reporting procedures.
  • Adds bidirectional language links.
File summaries
File Summary
SECURITY.md Adds a link to the Chinese security policy.
docs/SECURITY.zh-Hans.md Adds the Simplified Chinese security policy.
docs/CONTRIBUTING.zh-Hans.md Adds the translated contributing guide; formatting commands need correction.
CONTRIBUTING.md Adds a link to the Chinese contributing guide.
Review details

Suppressed comments (1)

docs/CONTRIBUTING.zh-Hans.md:81

  • These Bash/Git Bash globs are not recursive unless globstar is enabled, so the commands only cover Rust files one directory below src-tauri/src and skip the many nested modules (for example src-tauri/src/instance/helpers/...). That can report a clean format check while leaving most of the backend unchecked; use a recursive find/xargs invocation or otherwise enable recursive globbing here. The same correction should also be reflected in the English guide for parity.
rustfmt --check src-tauri/src/**/*.rs              # 检查
rustfmt src-tauri/src/**/*.rs                      # 修复
  • Files reviewed: 4/4 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/CONTRIBUTING.zh-Hans.md
@VhahahaV
VhahahaV force-pushed the docs/add-zh-hans-contributing-security branch from b43aa24 to c852449 Compare September 15, 2026 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants