[build] update templates and auto-label issues and PRs (#15542)

titusfortner · web-flow · commit 38234bd8954d · 2025-04-02T13:12:11.000-07:00
* [build] update templates and auto-label issues

* [build] update PR template
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,94 +1,127 @@
 name: 🐛 Bug Report
 description: File a bug report
 title: "[🐛 Bug]: "
-labels: [ I-defect, needs-triaging ]
+labels: [ I-defect, A-needs-triaging ]
 body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this bug report!
   - type: textarea
-    id: what-happened
+    id: description
     attributes:
-      label: What happened?
-      description: |
-        Describe clearly and concisely the bug including instructions showing how to reproduce it.
+      label: Description
       placeholder: |
-        Please add as many details as possible to avoid assumptions from our side. How do you
-        trigger this bug? What did you expect to happen? Please walk us through it step by step.
-        Notes:
-        If the issue is with Google Chrome consider logging an issue with ChromeDriver instead:
-        https://bugs.chromium.org/p/chromedriver
-        If the issue is with Firefox GeckoDriver (aka Marionette) consider logging an issue with
-        Mozilla: https://bugzilla.mozilla.org/buglist.cgi?product=Testing&component=Marionette
-        If the issue is with Microsoft Edge consider logging an issue with Microsoft instead:
-        https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/
-        If the issue is with Safari, only Safari 10+ is supported. Please log any Safari issue
-        with Apple: https://bugreport.apple.com/
+        Include details like:
+        - What you were trying to do
+        - What you expected to happen
+        - What actually happened
+        - Any relevant context or configuration
+        - Stacktrace or error message if applicable
     validations:
       required: true
   - type: textarea
-    id: repro-command
+    id: reproduction
     attributes:
-      label: How can we reproduce the issue?
-      description: |
-        Share with a code snippet or a GitHub repo to reproduce the issue.
+      label: Reproducible Code
       placeholder: |
-        Please share the code script to reproduce the issue. If more than one file is needed,
-        create a GitHub repository and share the link.
-        This will be automatically formatted into code, so no need for backticks.
-        Be sure to include an SSCCE (Short, Self Contained, Correct
-        [compilable] example) http://sscce.org/
-        Issues without a reproduction script are likely to stall and eventually be closed.
+        (This section renders as code, no need for backticks)
+
+        * We can't fix an issue we can't reproduce.
+        * If more than one file is needed, create a new GitHub repository and link it here.
+        * Reproduction should be SSCCE: Short, Self Contained, Correct (Compilable), Example.
       render: shell
     validations:
       required: true
   - type: textarea
     id: logs
     attributes:
-      label: Relevant log output
-      description: |
-        Please copy and paste any relevant log output.
-        Ideally, turn on more detailed logging: https://www.selenium.dev/documentation/webdriver/troubleshooting/logging/
-        This will be automatically formatted, so no need for backticks.
-      render: shell
-    validations:
-      required: true
+      label: Debugging Logs
+      placeholder: |
+        Note: the stack trace should be in the explanation section above
+        Instructions for enabling logging can be found in the link below
+      render: logs
+  - type: markdown
+    id: link
+    attributes:
+      value: |
+        **Read our [logging documentation](https://www.selenium.dev/documentation/webdriver/troubleshooting/logging/)**
+        &nbsp;
+
+        ## Help us Address Your Issue Faster!
   - type: input
-    id: operating-system
+    id: selenium-version
     attributes:
-      label: Operating System
-      description: What host operating system are you using to run Selenium?
-      placeholder: Windows 10? macOS BigSur? Ubuntu?
+      label: What version of Selenium are you currently using?
+      description: Important! The latest released version of Selenium is 4.30 and we can't fix old versions.
+      placeholder: e.g., 4.17.0
     validations:
       required: true
-  - type: input
-    id: selenium-version
+  - type: checkboxes
+    id: prerequisites
+    attributes:
+      label: The following statements are true
+      options:
+        - label: This applies to the most recent version of Selenium (we can't fix old versions)
+          required: true
+        - label: This hasn't already been reported (I searched and didn't find it)
+          required: true
+        - label: All information necessary to reproduce the issue has been provided above
+          required: true
+  - type: dropdown
+    id: regression
     attributes:
-      label: Selenium version
-      description: What programming language release version of Selenium?
-      placeholder: Java 4.0.0? Ruby 4.0.3? (please use the full version number).
+      label: Did this work for you before?
+      options:
+        - Not sure, this is my first time trying it
+        - Yes this is a regression
     validations:
       required: true
   - type: input
-    id: browser-versions
+    id: last-good
+    attributes:
+      label: If yes, what version of Selenium did it work with?
+      placeholder: "e.g., 4.8.0"
+    validations:
+      required: false
+  - type: dropdown
+    id: operating-system
     attributes:
-      label: What are the browser(s) and version(s) where you see this issue?
-      description: What browser and versions are you using?
-      placeholder: Example - Chrome 90, Firefox 88, etc.
+      label: Operating System
+      options:
+        - "--"
+        - Windows
+        - macOS
+        - Linux (specify in the description)
     validations:
       required: true
-  - type: input
-    id: browser-driver-versions
+  - type: dropdown
+    id: bindings
     attributes:
-      label: What are the browser driver(s) and version(s) where you see this issue?
-      description: What browser driver(s) are you using?
-      placeholder: Example - ChromeDriver 94.0.4606.61, GeckoDriver 0.30.0, etc.
+      label: Selenium Language Binding
+      options:
+        - "--"
+        - Java
+        - Python
+        - C#/.NET
+        - JavaScript/Node.js
+        - Ruby
     validations:
       required: true
-  - type: input
-    id: selenium-grid-version
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: Which browsers are you experiencing the issue with?
+      multiple: true
+      options:
+        - Chrome
+        - Firefox
+        - Edge
+        - Safari
+        - IE
+        - Other (please specify in the description)
+  - type: dropdown
+    id: grid
     attributes:
       label: Are you using Selenium Grid?
-      description: What version of Selenium Grid are you using?
-      placeholder: Example - 4.0.0
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_proposal.yml b/.github/ISSUE_TEMPLATE/feature_proposal.yml
@@ -1,31 +1,53 @@
 name: 🚀 Feature Proposal
-description: Propose a feature
+description: Suggest a new feature or improvement to Selenium
 title: "[🚀 Feature]: "
-labels: [ I-enhancement, needs-triaging ]
+labels: [ I-enhancement, A-needs-triaging ]
 body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to propose a feature!
   - type: textarea
-    id: feature-description
+    id: description
     attributes:
-      label: Feature and motivation
-      description: |
-        Describe clearly and concisely the feature you are proposing, what is the motivation
-        behind it.
+      label: Description
       placeholder: |
-        Help us to understand your proposal by adding as many details as possible, we will look into
-        it and give you feedback as soon as possible.
+        What would you like Selenium to support or do differently?
+        Please include:
+        - The problem this would solve
+        - How you expect the feature would work
+        - Any relevant context or use cases
+        - Links to related issues, discussions, or external tools (if applicable)
     validations:
       required: true
+
   - type: textarea
-    id: feature-example
+    id: alternatives
     attributes:
-      label: Usage example
-      description: |
-        How would you use this feature?
+      label: Have you considered any alternatives or workarounds?
       placeholder: |
-        A clear example showing how this feature is useful for you and the Selenium community.
+        If you've tried other ways to solve this problem, describe them here.
+        If not, you can leave this blank.
     validations:
-      required: true
+      required: false
+
+  - type: dropdown
+    id: bindings
+    attributes:
+      label: Does this apply to specific language bindings?
+      multiple: true
+      options:
+        - Java
+        - Python
+        - C#/.NET
+        - JavaScript/Node.js
+        - Ruby
+
+  - type: dropdown
+    id: components
+    attributes:
+      label: What part(s) of Selenium does this relate to?
+      multiple: true
+      options:
+        - Atoms
+        - Build (CI or Bazel)
+        - DevTools (CDP or BiDi)
+        - Documentation
+        - Grid
+        - Selenium Manager
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,26 +1,24 @@
-**Thanks for contributing to Selenium!**
-**A PR well described will help maintainers to quickly review and merge it**
+<!-- Thanks for Contributing to Selenium! -->
+<!-- Please read our contribution guidelines: https://github.com/SeleniumHQ/selenium/blob/trunk/CONTRIBUTING.md -->
 
-Before submitting your PR, please check our [contributing](https://github.com/SeleniumHQ/selenium/blob/trunk/CONTRIBUTING.md) guidelines.
-Avoid large PRs, help reviewers by making them as simple and short as possible.
+### 🔗 Related Issues
+<!-- Example: Fixes #1234 or Closes #5678 -->
+<!-- If the reason for this PR is not obvious, consider creating an issue for it first -->
 
-<!--- Provide a general summary of your changes in the Title above -->
+### 💥 What does this PR do?
+<!-- Describe what this change includes and how it works -->
 
-### Motivation and Context
-<!--- Why is this change required? What problem does it solve? -->
+### 🔧 Implementation Notes
+<!--- Why did you implement it this way? -->
+<!--- What alternatives to this approach did you consider? -->
 
-### Types of changes
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+### 💡 Additional Considerations
+<!--- Are there any decisions that need to be made before accepting this PR? -->
+<!--- Is there any follow-on work that needs to be done? (e.g., docs, tests, etc.) -->
 
-### Checklist
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] I have read the [contributing](https://github.com/SeleniumHQ/selenium/blob/trunk/CONTRIBUTING.md) document.
-- [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.
-- [ ] I have added tests to cover my changes.
-- [ ] All new and existing tests passed.
-<!--- Provide a general summary of your changes in the Title above -->
+### 🔄 Types of changes
+<!-- ✂️ Please delete anything that doesn't apply -->
+- Cleanup (formatting, renaming)
+- Bug fix (backwards compatible)
+- New feature (non-breaking change which adds functionality *and tests!*)
+- Breaking change (fix or feature that would cause existing functionality to change)
diff --git a/.github/issue-labeler-config.yml b/.github/issue-labeler-config.yml
@@ -0,0 +1,61 @@
+policy:
+  - section:
+      - id: [operating-system]
+        label:
+          - name: OS-windows
+            keys: [ Windows ]
+          - name: OS-mac
+            keys: [ macOS ]
+          - name: OS-linux
+            keys: [ Linux (specify in the description) ]
+
+      - id: [bindings]
+        label:
+          - name: C-java
+            keys: [ Java ]
+          - name: C-py
+            keys: [ Python ]
+          - name: C-dotnet
+            keys: [ C#/.NET ]
+          - name: C-rb
+            keys: [ Ruby ]
+          - name: C-nodejs
+            keys: [ JavaScript/Node.js ]
+
+      - id: [regression]
+        label:
+          - name: I-regression
+            keys: [ Yes this is a regression ]
+
+      - id: [components]
+        label:
+          - name: B-grid
+            keys: [ Grid ]
+          - name: B-docs
+            keys: [ Documentation ]
+          - name: B-devtools
+            keys: [ DevTools (CDP or BiDi) ]
+          - name: B-manager
+            keys: [ Selenium Manager ]
+          - name: B-build
+            keys: [ Build (CI or Bazel) ]
+          - name: B-atoms
+            keys: [ Atoms ]
+
+      - id: [browsers]
+        label:
+          - name: D-chrome
+            keys: [ Chrome ]
+          - name: D-firefox
+            keys: [ Firefox ]
+          - name: D-safari
+            keys: [ Safari ]
+          - name: D-edge
+            keys: [ Edge ]
+          - name: D-IE
+            keys: [ IE ]
+
+      - id: [grid]
+        label:
+          - name: B-grid
+            keys: [ "Yes" ]
diff --git a/.github/workflows/issue-labeler.yml b/.github/workflows/issue-labeler.yml
diff --git a/Rakefile b/Rakefile
