Skip to content

Conversation

@rpallavisharma
Copy link
Member

@rpallavisharma rpallavisharma commented Oct 4, 2025

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.

Description

When people provide code examples for documentation, it is recommended that they use web pages
listed on the link - https://www.selenium.dev/selenium/web/
to ensure we have a standard practice and the examples always run.

Motivation and Context

people may use web pages which may or may not run in future.
by doing this our code examples will have some standard

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

  • Added guidance for using standardized test web pages in code examples

  • Recommended using selenium.dev/selenium/web/ for consistent documentation examples


Diagram Walkthrough

flowchart LR
  A["Contributing Guidelines"] --> B["Code Examples Section"]
  B --> C["New Recommendation"]
  C --> D["Use selenium.dev/selenium/web/"]
Loading

File Walkthrough

Relevant files
Documentation
contributing.en.md
Added standardized web page guidance for examples               

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

  • Added recommendation to use standardized test web pages for code
    examples
  • Included link to selenium.dev/selenium/web/ as the preferred source
  • Positioned guidance between existing test-related instructions
+3/-0     

@netlify
Copy link

netlify bot commented Oct 4, 2025

Deploy Preview for selenium-dev ready!

Name Link
🔨 Latest commit 5bf4118
🔍 Latest deploy log https://app.netlify.com/projects/selenium-dev/deploys/6909c9d041578100089c0829
😎 Deploy Preview https://deploy-preview-2492--selenium-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Oct 4, 2025

PR Compliance Guide 🔍

(Compliance updated until commit 5bf4118)

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 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: 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 without system actions or logging, so audit
trail applicability cannot be determined from the diff.

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 changes are prose in markdown files with no identifiers or code elements to evaluate
for naming clarity.

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 Applicable: Only documentation text was added; there are no executable code paths or error handling to
assess in this diff.

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: Secure Error Handling

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

Status:
Not Applicable: The PR introduces no user-facing error handling or runtime messages; only static
documentation content was modified.

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: Security-First Input Validation and Data Handling

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

Status:
Not Applicable: No input handling or data processing was added; the diff only updates documentation text
referencing example web pages.

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/.
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

Previous compliance checks

Compliance check up to commit f669d9f
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
No custom compliance provided

Follow the guide to enable custom compliance check.

@rpallavisharma
Copy link
Member Author

please note this is only done for english version of the document. for other languages translations will be required.

@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Oct 4, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

Copy link
Member

@diemol diemol left a comment

Choose a reason for hiding this comment

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

Can you put the same text in the other languages? At least it will serve as a placeholder.

@rpallavisharma
Copy link
Member Author

let me see, if i could, i would do it Diego @diemol

@rpallavisharma
Copy link
Member Author

#2525 does for 2 more files. unable to do for .ja file, don't understand.

@diemol
Copy link
Member

diemol commented Nov 3, 2025

Why don't you put all the changes in the same PR?

@rpallavisharma
Copy link
Member Author

What is the issue with them being separate Diego? @diemol at the end we are getting the work being completed.
I don't understand.

@diemol
Copy link
Member

diemol commented Nov 4, 2025

Typically, a PR contains all changes related to the same logical unit or change set. Breaking the same unit into several PRs makes it harder for a reviewer to understand the scope and changes related to it.

It should be fine in this case because it is a small change, but in general, a single PR with all related changes is preferred.

@diemol diemol merged commit 4dc5f22 into SeleniumHQ:trunk Nov 4, 2025
6 checks passed
selenium-ci added a commit that referenced this pull request Nov 4, 2025
* added information about web examples for the english document

* Replicating change from contributing.en.md to other files

---------

[deploy site] 4dc5f22
@rpallavisharma rpallavisharma deleted the Fix2445 branch November 4, 2025 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants