SeleniumHQ/seleniumhq.github.io

[馃殌 Feature]: Improve README Files for contributing to code examples

Open

#2,243 opened on Mar 26, 2025

View on GitHub
聽(1 comment)聽(0 reactions)聽(2 assignees)HTML聽(712 stars)聽(1,015 forks)batch import
I-enhancementgood first issuehacktoberfestneeds-triaging

Description

Feature and motivation

Each language-example folder contains a README.md file, but they lack detailed information on prerequisites, installation steps, and contribution guidelines.

readme.md files are in here

https://github.com/SeleniumHQ/seleniumhq.github.io/tree/trunk/examples

Usage example

Need precise steps in readme.md for each language examples:

pre-requisites:

  • Install and configure Java
  • install and Configure Maven

Python:

  • Install and configure python
  • Install and configure pip

....

Contributor guide

Tech stack
javapython
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the existing README files in each language example folder under trunk/examples. Identify missing prerequisites and installation steps for each language (e.g., Java, Python). Propose standardized formatting and content updates for all README files.
[馃殌 Feature]: Improve README Files for contributing to code examples 路 SeleniumHQ/seleniumhq.github.io#2243 | Good First Issue