Skip to content

[dotnet][java][js][py][rb] Standardize README files across bindings#17245

Open
aguspe wants to merge 10 commits intoSeleniumHQ:trunkfrom
aguspe:readme-consistency
Open

[dotnet][java][js][py][rb] Standardize README files across bindings#17245
aguspe wants to merge 10 commits intoSeleniumHQ:trunkfrom
aguspe:readme-consistency

Conversation

@aguspe
Copy link
Copy Markdown
Contributor

@aguspe aguspe commented Mar 21, 2026

🔗 Related Issues

#16740

💥 What does this PR do?

Standardize all binding README files to a consistent template, create missing Java README, and link to selenium.dev instead of reproducing docs.

🔄 Types of changes

  • Documentation

Copilot AI review requested due to automatic review settings March 21, 2026 21:21
@selenium-ci selenium-ci added C-py Python Bindings C-rb Ruby Bindings C-dotnet .NET Bindings C-java Java Bindings C-nodejs JavaScript Bindings labels Mar 21, 2026
@qodo-code-review
Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Standardize README files across all language bindings

📝 Documentation

Grey Divider

Walkthroughs

Description
• Standardize README files across all language bindings with consistent template
• Create new Java README following standardized format
• Replace verbose documentation with links to selenium.dev
• Add quick start examples and installation instructions for each binding
• Simplify support and contribution sections across all READMEs

Grey Divider

File Changes

1. dotnet/src/webdriver/assets/nuget/README.md 📝 Documentation +34/-8

Standardize .NET README with consistent template

• Restructured with standardized sections: Installation, Quick Start, Documentation, Support,
 Contributing, License
• Simplified quick start example to focus on core functionality
• Replaced verbose introduction with concise description linking to selenium.dev
• Added Selenium Manager note about automatic driver installation
• Consolidated contribution guidelines and added license section

dotnet/src/webdriver/assets/nuget/README.md


2. java/README.md 📝 Documentation +61/-0

Create new standardized Java README

• Created new README file with standardized template
• Includes Installation section with Maven and Gradle examples
• Provides Quick Start example demonstrating basic WebDriver usage
• Links to official documentation and support channels
• Follows same structure as other language bindings

java/README.md


3. javascript/selenium-webdriver/README.md 📝 Documentation +24/-203

Simplify JavaScript README to standard template

• Removed extensive documentation about driver installation and Node support policy
• Replaced 230+ lines with concise 51-line standardized template
• Simplified installation and quick start sections
• Removed detailed Node version support tables and issue reporting guidelines
• Added Selenium Manager note and standardized documentation links

javascript/selenium-webdriver/README.md


View more (2)
4. py/docs/source/index.rst 📝 Documentation +18/-129

Simplify Python documentation to essential content

• Removed "Supported Browsers" section listing Chrome, Edge, Firefox, Safari, etc.
• Removed detailed driver installation instructions and links
• Removed multiple example code blocks (Examples 0, 1, 2)
• Removed Selenium Grid and contributing guidelines sections
• Simplified to Quick Start, Documentation, and Contributing sections with links

py/docs/source/index.rst


5. rb/README.md 📝 Documentation +40/-23

Standardize Ruby README with consistent template

• Restructured with standardized sections: Installation, Quick Start, Documentation, Support,
 Contributing, Links, License
• Replaced verbose license text with simple Apache 2.0 reference
• Added quick start Ruby code example
• Consolidated links section and added Selenium Manager note
• Simplified contribution and support information

rb/README.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown
Contributor

qodo-code-review bot commented Mar 21, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider


Action required

1. Invalid Java dependency version🐞 Bug ≡ Correctness
Description
java/README.md instructs users to depend on selenium-java version "LATEST" for both Maven and
Gradle, which does not match the concrete semantic versioning used by this repo’s Java artifacts.
Users following the README will fail to resolve/install the dependency as written.
Code

java/README.md[R10-22]

+```xml
+<dependency>
+    <groupId>org.seleniumhq.selenium</groupId>
+    <artifactId>selenium-java</artifactId>
+    <version>LATEST</version>
+</dependency>
+```
+
+### Gradle
+
+```groovy
+implementation 'org.seleniumhq.selenium:selenium-java:LATEST'
+```
Evidence
The README hardcodes "LATEST" as the dependency version, but the Java project versioning in-repo is
a concrete semver string (not a token like "LATEST"), indicating the README example is not aligned
with how artifacts are versioned/released.

java/README.md[10-22]
java/version.bzl[1-2]

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

## Issue description
`java/README.md` uses `LATEST` as the Maven/Gradle dependency version for `org.seleniumhq.selenium:selenium-java`, which is not aligned with this repo’s concrete semver versioning and will cause users to fail when copy/pasting the installation instructions.
### Issue Context
This file is newly added as part of standardizing binding READMEs. Other bindings (npm/gem/dotnet) can install “latest” implicitly via their package managers, but Maven/Gradle examples need an explicit, valid version value or a clearly marked placeholder.
### Fix Focus Areas
- java/README.md[10-22]
- java/version.bzl[1-2]
### What to change
- Replace `LATEST` with either:
- a concrete version (e.g., the current release version), or
- a placeholder pattern (e.g., `4.x.y`) accompanied by text like &amp;quot;replace with the latest version&amp;quot; and/or a link to where to find the latest released version.
- Ensure Maven and Gradle snippets are both updated consistently.

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


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Standardizes language-binding README/docs entrypoints so end-user docs live on selenium.dev, improving consistency across package manager listings and reducing duplicated documentation.

Changes:

  • Replaced existing Ruby, JavaScript, and .NET README content with a shared template (install, quick start, docs/support links, license).
  • Simplified the Python docs index page to a shorter “Quick Start + links” layout.
  • Added a new Java README with installation instructions, quick start, and links.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
rb/README.md Updates Ruby binding README to the standardized template and links to selenium.dev docs.
py/docs/source/index.rst Shortens Python docs landing page and points readers to selenium.dev documentation.
javascript/selenium-webdriver/README.md Replaces the long JS README with the standardized template and docs/support links.
java/README.md Adds a new Java README aligned to the template (install, quick start, docs/support).
dotnet/src/webdriver/assets/nuget/README.md Reworks the NuGet README to the standardized template and selenium.dev links.

Comment thread java/README.md
Comment thread java/README.md
Comment thread py/docs/source/index.rst Outdated
Comment thread java/README.md
Copilot AI review requested due to automatic review settings April 4, 2026 08:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Comment thread java/README.md Outdated
Comment thread dotnet/src/webdriver/assets/nuget/README.md Outdated
Comment thread java/README.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 4, 2026 09:01
aguspe and others added 2 commits April 4, 2026 11:01
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

Comment thread java/README.md Outdated
Copilot AI review requested due to automatic review settings April 4, 2026 20:06
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

@AutomatedTester
Copy link
Copy Markdown
Member

The python change is for the documentation not readme. It also seems to remove examples and it's "simplified" things by removing things rather than clarifying things

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-dotnet .NET Bindings C-java Java Bindings C-nodejs JavaScript Bindings C-py Python Bindings C-rb Ruby Bindings

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants