Skip to content

Conversation

pallavigitwork
Copy link
Member

@pallavigitwork pallavigitwork commented Aug 23, 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.

modified governance document

Description

modified governance document heading.
listed objectives
removed roles of documenters and translators

Motivation and Context

To ease and streamline roles for selenium project, based on generic roles which govern open source projects.
reference link -https://opensource.guide/how-to-contribute/

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

  • Restructured governance document with new objectives section

  • Removed documenter and translator roles from governance structure

  • Enhanced contributor and committer role descriptions

  • Improved clarity and organization of governance framework


Diagram Walkthrough

flowchart LR
  A["Original Governance"] --> B["Enhanced Introduction"]
  A --> C["New Objectives Section"]
  A --> D["Streamlined Roles"]
  D --> E["Removed Documenter Role"]
  D --> F["Removed Translator Role"]
  D --> G["Enhanced Contributor Description"]
  D --> H["Improved Committer Requirements"]
Loading

File Walkthrough

Relevant files
Documentation
_index.html
Restructured governance framework with streamlined roles 

website_and_docs/content/project/governance/_index.html

  • Added new "Governance Objective" section with three core objectives
  • Removed documenter and translator role sections entirely
  • Enhanced contributor role description with clearer examples
  • Updated committer requirements and qualification criteria
+45/-71 

@pallavigitwork pallavigitwork requested a review from diemol August 23, 2025 13:10
Copy link

netlify bot commented Aug 23, 2025

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit ce25fc8

Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Content Clarity

In the "Contributors" section, some sentences became awkward or incomplete after edits (e.g., the bullet introducing examples, and the privileges sentence). Please ensure sentences read naturally and links have proper leading text.

Contributors are community members who contribute in concrete ways to the project,
most often in the form of code and/or documentation in the respective project repository. 
Anyone can become a contributor, and contributions can take many forms, other than code contributions, e.g.:
<ul>
    <li>
      <p class="m-0">
        Actively help other users through any of the <a href="#communication-channels">communication channels</a>
        made for that purpose.
      </p>
    </li>
    <li>
        Triage GitHub issues.
    </li>
   <li>
        Organize and collaborate in Selenium meetups, events and conferences.
    </li>
</ul>

<p>
  There is no expectation of commitment to the project, no specific skill requirements,
  and no selection process.
  Some Contributors might have some basic privileges to the GitHub repos to which they have contributed, based on
  their type of contribution (e.g., close an issue after triaging it).
</p>
Consistency

Product and project names are inconsistently referenced (e.g., "Selenium IDE" vs earlier "IDE", "WebSite & Docs" vs "Site & Docs"; "github" vs "GitHub"). Standardize naming and capitalization across the document.

<p class="pb-4">
  Committers are contributors who have shown that they are committed to the
  continued development of the project through ongoing engagement with the project.
  Committers are given push access to the project's GitHub repos where they
  contribute to. Example getting access to the selenium-docker repository for those contribute to it. 
</p>

<p class="fw-bold">
  Committers:
</p>
<ul>
    <li>
        Should bring their proposals for large changes to the project's code first to
        a GitHub issue, and all relevant committers should be pinged so they can weigh
        in on the discussion if desired.
    </li>
    <li>
        Debates between committers about whether code should be merged should happen
        in GitHub pull requests to keep the project decision history.
    </li>
    <li>
        In general any committer can review and merge a pull request. Committers
        should only merge code they are qualified to review, which might entail pinging
        another committer who has greater ownership over a specific code area.
    </li>
    <li>
        May label and close issues.
    </li>
</ul>

<h4 class="pt-3">Becoming a committer</h4>

<ul>
    <li>
        One must have shown a willingness and ability to participate in the project as
        a team player.
    </li>
    <li>
        Committers are expected to be respectful of every community member and to work
        collaboratively in the spirit of inclusion.
    </li>
    <li>
        Have submitted sufficient substantive contributions to one or more of the
        different projects (Selenium IDE, Docker-Selenium, Selenium Client Bindings, WebSite & Docs). 
        Normally 10 substantive contributions are needed to qualify as a candidate to be a committer, but there
        could be cases where the contributions are substantial enough or technically significant enough that a fewer
        number is also acceptable.
    </li>
</ul>
HTML Semantics

The "Governance Objective" block nests multiple

tags and uses a stray

; consider proper paragraph structure and list markup for the three objectives for cleaner HTML and accessibility.

<div class="row -bg-selenium-cyan-20 justify-content-center">
  <div class="col-12 px-5 pt-5 bg-transparent">
    <h2>Governance Objective</h2>
    Our governance framework is designed to achieve three core objectives:
    <p>
    <p>
    <b>Inclusive Participation</b> 
    <br>We ensure that all individuals, regardless of background or affiliation, have meaningful 
    opportunities to contribute to Selenium's development and direction.
    </p>

    <p>
    <b>Corporate Balance</b>
    <br>We maintain safeguards against undue corporate influence while preventing any single entity 
    from compromising the project's independence or community-driven nature.
    </p>

    <p>
    <b>Reciprocal Value</b>
    <br> We create structures that encourage organizations benefiting from Selenium to contribute back to the 
    project's sustainability and growth.
    </p>

    <br>This document outlines the roles, responsibilities, and processes that define how various 
    types of contributors work within the Selenium project.
    </div>
    </div>

Copy link
Contributor

qodo-merge-pro bot commented Aug 23, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
High-level
Clarify role removals

Removing documenter and translator roles from governance without defining where
those responsibilities now live risks creating ownership gaps for critical docs
and localization work. Either retain these roles or explicitly reassign their
scopes (e.g., under contributors/committers with clear privileges and processes)
to avoid degrading documentation quality and international community support.

Examples:

website_and_docs/content/project/governance/_index.html [48-56]
    <h2>Roles and Responsibilities</h2>
    <ul>
        <li><a href="#users">Users</a></li>
        <li><a href="#contributors">Contributors</a></li>
        <li><a href="#triagers">Triagers</a></li>
        <li><a href="#project-committers">Committers</a></li>
        <li><a href="#technical-leadership-committee-tlc">Technical Leadership Committee Members</a></li>
        <li><a href="#project-leadership-committee-plc">Project Leadership Committee Members</a></li>
    </ul>
website_and_docs/content/project/governance/_index.html [83-108]
      <h3 id="contributors">Contributors</h3>

      Contributors are community members who contribute in concrete ways to the project,
      most often in the form of code and/or documentation in the respective project repository. 
      Anyone can become a contributor, and contributions can take many forms, other than code contributions, e.g.:
      <ul>
          <li>
            <p class="m-0">
              Actively help other users through any of the <a href="#communication-channels">communication channels</a>
              made for that purpose.

 ... (clipped 16 lines)

Solution Walkthrough:

Before:

<h2>Roles and Responsibilities</h2>
<ul>
    <li><a href="#users">Users</a></li>
    <li><a href="#contributors">Contributors</a></li>
    ...
    <li><a href="#documenters">Documenters</a></li>
    <li><a href="#translators">Translators</a></li>
    ...
</ul>
...
<h3 id="documenters">Documenters</h3>
<p>...Documenters are community members...given push access...</p>
...
<h3 id="translators">Translators</h3>
<p>...A translator is responsible for all content in a given language...</p>

After:

<h2>Roles and Responsibilities</h2>
<ul>
    <li><a href="#users">Users</a></li>
    <li><a href="#contributors">Contributors</a></li>
    ...
</ul>
...
<h3 id="contributors">Contributors</h3>
<p>
  Contributors are community members who contribute in concrete ways to the project,
  most often in the form of code, documentation, and/or translation.
  Documentation and translation responsibilities include:
  <ul>
    <li>Improving examples and descriptions.</li>
    <li>Creating and updating content for a given language.</li>
    <li>Managing Pull Requests relevant to documentation and language files.</li>
  </ul>
</p>
Suggestion importance[1-10]: 9

__

Why: The suggestion correctly identifies a critical gap created by removing the Documenter and Translator roles without explicitly reassigning their crucial responsibilities, which could negatively impact project documentation and international support.

High
Possible issue
Fix malformed paragraph markup

Fix invalid HTML structure and semantics. Remove the stray opening

tag, wrap
the introductory sentence in a single

, and avoid using
for layout by moving text into paragraphs. Ensure div tags are properly
balanced.

website_and_docs/content/project/governance/_index.html [18-44]

 <div class="row -bg-selenium-cyan-20 justify-content-center">
   <div class="col-12 px-5 pt-5 bg-transparent">
     <h2>Governance Objective</h2>
-    Our governance framework is designed to achieve three core objectives:
+    <p>Our governance framework is designed to achieve three core objectives:</p>
     <p>
+      <strong>Inclusive Participation.</strong>
+      We ensure that all individuals, regardless of background or affiliation, have meaningful
+      opportunities to contribute to Selenium's development and direction.
+    </p>
     <p>
-    <b>Inclusive Participation</b> 
-    <br>We ensure that all individuals, regardless of background or affiliation, have meaningful 
-    opportunities to contribute to Selenium's development and direction.
+      <strong>Corporate Balance.</strong>
+      We maintain safeguards against undue corporate influence while preventing any single entity
+      from compromising the project's independence or community-driven nature.
     </p>
-    
     <p>
-    <b>Corporate Balance</b>
-    <br>We maintain safeguards against undue corporate influence while preventing any single entity 
-    from compromising the project's independence or community-driven nature.
+      <strong>Reciprocal Value.</strong>
+      We create structures that encourage organizations benefiting from Selenium to contribute back to the
+      project's sustainability and growth.
     </p>
-    
     <p>
-    <b>Reciprocal Value</b>
-    <br> We create structures that encourage organizations benefiting from Selenium to contribute back to the 
-    project's sustainability and growth.
+      This document outlines the roles, responsibilities, and processes that define how various
+      types of contributors work within the Selenium project.
     </p>
+  </div>
+</div>
 
-    <br>This document outlines the roles, responsibilities, and processes that define how various 
-    types of contributors work within the Selenium project.
-    </div>
-    </div>
-
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly identifies invalid HTML (an extra <p> tag) and improves semantics by replacing <br> tags with proper paragraph structures, enhancing code quality and correctness.

Low
General
Correct unclear grammar

Correct grammar for clarity and professionalism. The sentence currently reads
awkwardly and may confuse readers.

website_and_docs/content/project/governance/_index.html [151-152]

-Committers are given push access to the project's GitHub repos where they
-    contribute to. Example getting access to the selenium-docker repository for those contribute to it.
+Committers are given push access to the project's GitHub repositories to which they contribute. For example, contributors to Selenium Docker may be granted access to the selenium-docker repository.
  • Apply / Chat
Suggestion importance[1-10]: 5

__

Why: The suggestion correctly identifies and fixes grammatically incorrect sentences, which significantly improves the clarity and professionalism of the documentation.

Low
Fix GitHub capitalization

Capitalize proper nouns for consistency and branding. Use "GitHub" instead of
"github".

website_and_docs/content/project/governance/_index.html [128]

-role is to help triage issues and potentially submit Pull Requests in the github repos with fixes or at least a
+role is to help triage issues and potentially submit Pull Requests in the GitHub repos with fixes or at least a
  • Apply / Chat
Suggestion importance[1-10]: 3

__

Why: The suggestion correctly points out a minor inconsistency in capitalization for the proper noun GitHub, which improves branding consistency and professionalism.

Low
  • Update

@pallavigitwork
Copy link
Member Author

the governance document - can contain other roles defined in structure example - Conference Committee - https://www.selenium.dev/project/structure/

@pallavigitwork
Copy link
Member Author

should the repository of selenium client bindings be called seleniumclientbindings, or seleniumbindings , if PLC thinks that is helpful. we define committers as per repository / area to where people are contributing to. example selenium docker repository. so that it becomes self explanatory.

@pallavigitwork
Copy link
Member Author

pallavigitwork commented Aug 23, 2025

the blogs which we put out for releases has a section called as Selenium Team, there is no mention of Selenium Team in governance document. I think communications from project may think about being aligned to governance document described roles. - example - https://www.selenium.dev/blog/2025/selenium-4-35-released/
if PLC feels these should be modified. again to have clarity in communication. or define Selenium Team in structure

@pallavigitwork
Copy link
Member Author

the selenium communication channels might need a check - google group, librechat, matrix, slack etc (links and names). using twitter for congratulations? or slack or linkedin?

Copy link
Member

@titusfortner titusfortner left a comment

Choose a reason for hiding this comment

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

Thanks for making the PR so it is easier to evaluate.

Note that this documents the official governance as voted on by PLC, so it can't be merged until a vote has been made to change it.

@pallavigitwork
Copy link
Member Author

Aware of it, plc asked creation so it becomes easier to see diff. So this PR.
Have informed in the open plc slack channel to them about it.

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