Skip to content

docs: zh-cn contributing translation and update CLA link - #2745

Open
alaahong wants to merge 7 commits into
SeleniumHQ:trunkfrom
alaahong:fix/zh-cn-contributing-translation
Open

docs: zh-cn contributing translation and update CLA link#2745
alaahong wants to merge 7 commits into
SeleniumHQ:trunkfrom
alaahong:fix/zh-cn-contributing-translation

Conversation

@alaahong

Copy link
Copy Markdown
Member

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

update contributing translation and CLA link

Motivation and Context

CLA link is confusing for per language
Update Chinese contribution version

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

alaahong added 6 commits July 26, 2026 10:54
- Translate untranslated sections (What to Help With, Creating Examples, Moving Examples)
- Fix critical mistranslation: 'please don't worry' -> 'please do not hesitate to create an issue'
- Remove content not present in English version (submodule init steps)
- Add missing content from English version (GitHub code loading explanation)
- Fix punctuation: replace English periods/commas with Chinese equivalents
- Add spaces between Chinese and English/numbers
- Shorten linkTitle from '为 Selenium 文档做贡献' to '贡献'
- Fix section title: '贡献' -> '贡献机制' (Contribution Mechanics)
- Fix typo: '推push' -> 'push'
- Unify pronoun: '你' -> '您'
- Fix CLA reference: '步骤 7' -> '步骤 8'
- Align aliases indentation with English version (2 spaces)
- Title: add missing 'site' (站点) to match 'site & documentation'
- Fix 'ask' mistranslated as '描述' -> '询问' (line 39)
- Add missing 'valuable' -> '重大且有价值的贡献' (line 97)
- Fix 'dev' mistranslated as 'trunk' -> 'dev' (line 130)
- Add missing 'for contribution' -> '贡献规范' (line 148)
- Fix 'reference issues fixed' -> '引用已修复的问题' (line 162)
- Fix 'around 50' -> '大约 50 个字符或更少' (line 165)
- Add missing 'all other lines' -> '所有其他行' (line 167)
- Fix 'from time to time' mistranslated as '实时的' -> '不时地' (line 191)
- Remove incorrect '(see Step 7)' / '(ステップ7を参照)' / '(consulte a Etapa 7)' self-references
- Add CLA signing instructions: visit https://cla-assistant.io/SeleniumHQ/seleniumhq.github.io and click 'Sign in with GitHub to agree' button
- Update all 4 language versions: en, zh-cn, ja, pt-br
- Replace bare URL with markdown link [text](url) format
- Apply semantic linefeeds per style guide (~100 chars per line)
- Update all 4 language versions: en, zh-cn, ja, pt-br
- Replace bare URL with markdown link in Communication section
- Add missing period at end of zh-cn sentence
- Update all 4 language versions: en, zh-cn, ja, pt-br
- Add missing period at end of sentence
- Align phrasing with English version ('can be found at' -> '可以在...找到')
- Revert unnecessary URL changes in en/ja/pt-br versions (keep bare URLs as-is)
@netlify

netlify Bot commented Jul 26, 2026

Copy link
Copy Markdown

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 9d75566

@qodo-code-review

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Docs: clarify CLA signing link and improve zh-cn contributing translation

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Add explicit CLA signing instructions and link to cla-assistant.io in contributing docs.
• Improve zh-cn contributing translation to better match English source and terminology.
• Normalize wording/punctuation and remove/add content to align translations with upstream.
Diagram

graph TD
A["Contributor"] --> B["Contributing docs (EN/JA/PT/zh-cn)"] --> C["CLA Assistant link"] --> D["GitHub Pull Request"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Use a shared shortcode/partial for the CLA instruction block
  • ➕ Keeps CLA instructions identical across all languages
  • ➕ Future CLA URL/button-text changes require editing one place
  • ➖ Requires Hugo/Docsy templating changes and translator guidance
  • ➖ May reduce translation flexibility for nuanced language-specific wording
2. Centralize CLA URL in site config/params and reference it from docs
  • ➕ Prevents link drift while allowing localized prose around it
  • ➕ Minimal template complexity vs a full reusable block
  • ➖ Still requires touching content when instruction wording changes
  • ➖ Needs convention/discipline to ensure all pages use the param

Recommendation: The PR’s direct-content edits are appropriate for a quick fix and immediately reduce CLA confusion. If CLA instructions change frequently, consider extracting the CLA link/instruction snippet into a reusable shortcode or at least centralizing the URL in site params to avoid future inconsistencies across translations.

Files changed (4) +119 / -112

Documentation (4) +119 / -112
contributing.en.mdAdd explicit CLA signing URL and instructions +3/-1

Add explicit CLA signing URL and instructions

• Replaces the ambiguous “see Step 7” CLA note with direct instructions for signing via cla-assistant.io and the exact button text to click.

website_and_docs/content/documentation/about/contributing.en.md

contributing.ja.mdClarify CLA signing steps in Japanese contributing guide +5/-1

Clarify CLA signing steps in Japanese contributing guide

• Expands the CLA mention into an explicit signing flow, adding the cla-assistant.io link and guidance matching the English instruction intent.

website_and_docs/content/documentation/about/contributing.ja.md

contributing.pt-br.mdAdd CLA signing link and call-to-action in pt-br guide +3/-1

Add CLA signing link and call-to-action in pt-br guide

• Updates the CLA note to include the cla-assistant.io URL and explicit instructions to click the GitHub sign-in agreement button.

website_and_docs/content/documentation/about/contributing.pt-br.md

contributing.zh-cn.mdAlign zh-cn contributing page with English and fix CLA guidance +108/-109

Align zh-cn contributing page with English and fix CLA guidance

• Improves translation accuracy and consistency (terminology, punctuation, spacing, pronouns), translates previously-untranslated sections, and aligns content with the English source (including the GitHub code-loading/cache note). Also updates the CLA reference to the explicit cla-assistant.io link and corrects step references.

website_and_docs/content/documentation/about/contributing.zh-cn.md

@qodo-code-review

qodo-code-review Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (0)

Context used
✅ Compliance rules (platform): 10 rules

Grey Divider


Remediation recommended

1. Dev/trunk branch mismatch ✓ Resolved 🐞 Bug ≡ Correctness
Description
The zh-cn contributing guide now says changes are applied on top of dev, but later still tells
users to git rebase origin/trunk and says PRs are integrated into the trunk branch, giving
conflicting base-branch instructions.
Code

website_and_docs/content/documentation/about/contributing.zh-cn.md[130]

+我们实践基于 HEAD 的开发模式,这意味着所有更改都直接应用在 `dev` 之上。
Evidence
The same document states different “main” branches in different steps, which is internally
inconsistent and will confuse contributors following it.

website_and_docs/content/documentation/about/contributing.zh-cn.md[128-132]
website_and_docs/content/documentation/about/contributing.zh-cn.md[189-196]
website_and_docs/content/documentation/about/contributing.zh-cn.md[221-223]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The Chinese contributing guide mixes `dev` and `trunk` as the main branch (Step 2 says `dev`, while Step 5 and Step 8 still reference `trunk`). This creates contradictory Git workflow instructions.

## Issue Context
This inconsistency was introduced by updating Step 2 to mention `dev` without updating the later steps.

## Fix Focus Areas
- website_and_docs/content/documentation/about/contributing.zh-cn.md[128-132]
- website_and_docs/content/documentation/about/contributing.zh-cn.md[189-196]
- website_and_docs/content/documentation/about/contributing.zh-cn.md[221-223]

## Expected fix
Pick the correct canonical branch name for this repo and use it consistently across Step 2, the rebase command in Step 5, and the integration description in Step 8 (either make all `trunk` or all `dev`).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Previous review results

Review updated until commit 9d75566 ⚖️ Balanced

Results up to commit 56b9c88 ⚖️ Balanced


🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX issues (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)


Remediation recommended
1. Dev/trunk branch mismatch ✓ Resolved 🐞 Bug ≡ Correctness
Description
The zh-cn contributing guide now says changes are applied on top of dev, but later still tells
users to git rebase origin/trunk and says PRs are integrated into the trunk branch, giving
conflicting base-branch instructions.
Code

website_and_docs/content/documentation/about/contributing.zh-cn.md[130]

+我们实践基于 HEAD 的开发模式,这意味着所有更改都直接应用在 `dev` 之上。
Evidence
The same document states different “main” branches in different steps, which is internally
inconsistent and will confuse contributors following it.

website_and_docs/content/documentation/about/contributing.zh-cn.md[128-132]
website_and_docs/content/documentation/about/contributing.zh-cn.md[189-196]
website_and_docs/content/documentation/about/contributing.zh-cn.md[221-223]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The Chinese contributing guide mixes `dev` and `trunk` as the main branch (Step 2 says `dev`, while Step 5 and Step 8 still reference `trunk`). This creates contradictory Git workflow instructions.

## Issue Context
This inconsistency was introduced by updating Step 2 to mention `dev` without updating the later steps.

## Fix Focus Areas
- website_and_docs/content/documentation/about/contributing.zh-cn.md[128-132]
- website_and_docs/content/documentation/about/contributing.zh-cn.md[189-196]
- website_and_docs/content/documentation/about/contributing.zh-cn.md[221-223]

## Expected fix
Pick the correct canonical branch name for this repo and use it consistently across Step 2, the rebase command in Step 5, and the integration description in Step 8 (either make all `trunk` or all `dev`).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Qodo Logo

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

Pull request overview

This PR updates the “Contributing” documentation pages by improving the Simplified Chinese translation (including front matter and phrasing) and by clarifying how to sign the CLA via cla-assistant across several languages.

Changes:

  • Refreshed and reformatted the zh-cn contributing page content and front matter to better match current wording and formatting.
  • Updated the CLA instructions to include a direct cla-assistant link and the specific button text to click (EN / PT-BR / JA / ZH-CN).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
website_and_docs/content/documentation/about/contributing.zh-cn.md Major translation refresh, front matter cleanup, and expanded CLA instructions.
website_and_docs/content/documentation/about/contributing.pt-br.md Adds explicit cla-assistant signing instructions after the CLA mention.
website_and_docs/content/documentation/about/contributing.ja.md Adds explicit cla-assistant signing instructions after the CLA mention.
website_and_docs/content/documentation/about/contributing.en.md Adds explicit cla-assistant signing instructions after the CLA mention.

Comment thread website_and_docs/content/documentation/about/contributing.zh-cn.md Outdated
Comment thread website_and_docs/content/documentation/about/contributing.zh-cn.md Outdated
Step 2 of the Chinese contributing guide referenced dev as the base
branch, while Step 5 (rebase) and Step 8 (integration) both reference
	runk. Align Step 2 with the rest of the document and the actual
repository main branch, as flagged by Copilot and Qodo reviews.
@qodo-code-review

Copy link
Copy Markdown
Contributor

Code review by qodo was updated up to the latest commit 9d75566

@rpallavisharma

Copy link
Copy Markdown
Member

hey @alaahong i don't know the language. the checks have all passed.
TLC members can further review this. please assign to selenium tlc members. thanks

@rpallavisharma rpallavisharma removed their assignment Jul 29, 2026
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.

3 participants