Skip to content

added information for examples website#2525

Closed
rpallavisharma wants to merge 2 commits intoSeleniumHQ:trunkfrom
rpallavisharma:updateContribution
Closed

added information for examples website#2525
rpallavisharma wants to merge 2 commits intoSeleniumHQ:trunkfrom
rpallavisharma:updateContribution

Conversation

@rpallavisharma
Copy link
Copy Markdown
Member

@rpallavisharma rpallavisharma commented Nov 3, 2025 •
edited by qodo-code-review Bot
Loading

User description

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.

added information in 2 files for #2492

Description

added information for using website for examples

Motivation and Context

so that when creating example codes, people can know which websites to take

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.

PR Type

Documentation

Description

Diagram Walkthrough

flowchart LR
  A["Contributing Guidelines"] -- "Add website recommendation" --> B["Test Web Pages Reference"]
  B -- "Applied to" --> C["Portuguese Translation"]
  B -- "Applied to" --> D["Chinese Translation"]
Loading

File Walkthrough
Relevant files
Documentation
contributing.pt-br.md
Add test website guidance to Portuguese contributing docs

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

  • Added guidance recommending use of test web pages for code examples
  • Included link to https://www.selenium.dev/selenium/web/
  • Clarifies that examples should use consistent test websites
 +4/-0     
contributing.zh-cn.md
Add test website guidance to Chinese contributing docs     

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

  • Added guidance recommending use of test web pages for code examples
  • Included link to https://www.selenium.dev/selenium/web/
  • Clarifies that examples should use consistent test websites
 +4/-0     

@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 3, 2025 •
edited
Loading

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 5c586cd

@qodo-code-review
Copy link
Copy Markdown
Contributor

qodo-code-review Bot commented Nov 3, 2025 •
edited
Loading

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
⚪
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

⚪
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status:
Not Applicable: The PR only adds static documentation text with no executable actions to log; audit trail
requirements are not applicable to these changes.

Referred Code 
Code examples may need a relevant website or web page to demonstrate the scenario. To ensure examples consistently work, 
it is recommended to use the test web pages available at https://www.selenium.dev/selenium/web/.
Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status:
Not Code Change: The PR adds prose to documentation without introducing identifiers or code constructs to
evaluate for naming conventions.

Referred Code 
Code examples may need a relevant website or web page to demonstrate the scenario. To ensure examples consistently work, 
it is recommended to use the test web pages available at https://www.selenium.dev/selenium/web/.
Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status:
Not Code Path: The new additions are guidance text only and introduce no executable error paths to assess
for handling or edge cases.

Referred Code 
Code examples may need a relevant website or web page to demonstrate the scenario. To ensure examples consistently work, 
it is recommended to use the test web pages available at https://www.selenium.dev/selenium/web/.
  • Update
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@rpallavisharma rpallavisharma mentioned this pull request Nov 3, 2025
Merged
6 tasks
@qodo-code-review
Copy link
Copy Markdown
Contributor

qodo-code-review Bot commented Nov 3, 2025 •
edited
Loading

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Translate documentation content to Portuguese

Translate the newly added English content in the Portuguese documentation file
(contributing.pt-br.md) to Portuguese.

website_and_docs/content/documentation/about/contributing.pt-br.md [84-85]

-Code examples may need a relevant website or web page to demonstrate the scenario. To ensure examples consistently work, 
-it is recommended to use the test web pages available at https://www.selenium.dev/selenium/web/.
+Os exemplos de código podem precisar de um site ou página da web relevante para demonstrar o cenário. Para garantir que os exemplos funcionem de forma consistente, 
+é recomendado usar as páginas da web de teste disponíveis em https://www.selenium.dev/selenium/web/.
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly points out that English text was added to a Portuguese documentation file, which harms the consistency and readability for the target audience.

Medium
Translate documentation content to Chinese

Translate the newly added English content in the Chinese documentation file
(contributing.zh-cn.md) to Chinese.

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

-Code examples may need a relevant website or web page to demonstrate the scenario. To ensure examples consistently work, 
-it is recommended to use the test web pages available at https://www.selenium.dev/selenium/web/.
+代码示例可能需要一个相关的网站或网页来演示该场景。为确保示例持续有效，
+建议使用 https://www.selenium.dev/selenium/web/ 上提供的测试网页。
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly points out that English text was added to a Chinese documentation file, which harms the consistency and readability for the target audience.

Medium
  • Update

@diemol
Copy link
Copy Markdown
Member

diemol commented Nov 4, 2025

Changes are already part of #2492

@diemol diemol closed this Nov 4, 2025
@rpallavisharma rpallavisharma deleted the updateContribution branch November 4, 2025 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Review effort 1/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rpallavisharma @diemol