Skip to content

Conversation

pallavigitwork
Copy link
Member

@pallavigitwork pallavigitwork 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     

Copy link

netlify bot commented Oct 4, 2025

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit f669d9f

Copy link
Contributor

qodo-merge-pro bot commented Oct 4, 2025

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
No custom compliance provided

Follow the guide to enable custom compliance check.

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@pallavigitwork
Copy link
Member Author

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

Copy link
Contributor

qodo-merge-pro bot commented Oct 4, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

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.

1 participant