From 49ebfb9f91c400ce5997218aa94e40a4152c396e Mon Sep 17 00:00:00 2001 From: Diego Molina Date: Thu, 14 Oct 2021 16:47:50 +0200 Subject: [PATCH] Moving from issue templates to issue forms. [skip ci] --- .github/ISSUE_TEMPLATE.md | 16 ---- .github/ISSUE_TEMPLATE/bug-report.yml | 100 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug.md | 55 ----------- .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature.md | 17 ---- .github/ISSUE_TEMPLATE/feature_proposal.yml | 31 ++++++ .github/ISSUE_TEMPLATE/question.md | 14 --- .github/ISSUE_TEMPLATE/regression.md | 61 ------------ .github/selenium-assistant.yml | 72 -------------- 9 files changed, 139 insertions(+), 235 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/feature_proposal.yml delete mode 100644 .github/ISSUE_TEMPLATE/question.md delete mode 100644 .github/ISSUE_TEMPLATE/regression.md delete mode 100644 .github/selenium-assistant.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index f201192224fe3..0000000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ ---- - -name: 💬 Questions / Help -about: If you have questions, please check our IRC or Slack ---- - -## 💬 Questions and Help - -## Note: You didn't choose a template in the previous step, therefore this will be treated as a "Questions / Help" one. - -### Please note that this issue tracker is not a help form and this issue will be closed. - -For questions or help please see: - -- [SeleniumHQ IRC/Slack channel](https://www.selenium.dev/support/) -- [Selenium Users](https://groups.google.com/forum/#!forum/selenium-users) google group diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000000..f5542ce0011e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,100 @@ +name: 🐛 Bug Report +description: File a bug report +title: "[🐛 Bug]: " +labels: [ bug, needs-triaging ] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: | + Describe clearly and concisely the bug including instructions showing how to reproduce it. + 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/ + validations: + required: true + - type: textarea + id: repro-command + attributes: + label: Command used to start Selenium Grid with Docker + description: | + What command do you use to start Selenium Grid with Docker? + 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. + render: shell + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: | + Please copy and paste any relevant log output. This will be automatically formatted, so + no need for backticks. + render: shell + validations: + required: true + - type: input + id: operating-system + attributes: + label: Operating System + description: What host operating system are you using to run Selenium? + placeholder: Windows 10? macOS BigSur? Ubuntu? + validations: + required: true + - type: input + id: selenium-version + attributes: + label: Selenium version + description: What version of Selenium are you using? + placeholder: 4.0.0? Please use the full version number. + validations: + required: true + - type: input + id: browser-versions + 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. + validations: + required: true + - type: input + id: browser-driver-versions + 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. + validations: + required: true + - type: input + id: selenium-grid-version + attributes: + label: Are you using Selenium Grid? + description: What version of Selenium Grid are you using? + placeholder: Example - 4.0.0 diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 3ed9e8a8026d3..0000000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,55 +0,0 @@ ---- - -name: 🐛 Bug report -about: Create a report to help us improve ---- - -## 🐛 Bug Report - -A clear and concise description of what the bug is. - - - -## To Reproduce - - - -Detailed steps to reproduce the behavior: - -## Expected behavior - -A clear and concise description of what you expected to happen. - -## Test script or set of commands reproducing this issue - -Please provide a test script to reproduce the issue you are reporting, if the -setup is more complex, GitHub repo links with are also OK. - -Issues without a reproduction script are likely to stall and eventually be closed. - -## Environment - -OS: -Browser: -Browser version: -Browser Driver version: -Language Bindings version: -Selenium Grid version (if applicable): diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000000..534aafc1977f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Selenium Community Support and Questions + url: https://www.selenium.dev/support/ + about: Useful links to ask questions and join the different Selenium chat rooms. + - name: 📖 Selenium Documentation + url: https://www.selenium.dev/documentation/ + about: Issues while running tests? Please check the Selenium documentation before filling out an issue. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 67b51070a4264..0000000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,17 +0,0 @@ ---- - -name: 🚀 Feature Proposal -about: Submit a proposal for a new feature ---- - -## 🚀 Feature Proposal - -A clear and concise description of what the feature is. - -## Motivation - -Please outline the motivation for the proposal. - -## Example - -Please provide an example for how this feature would be used. diff --git a/.github/ISSUE_TEMPLATE/feature_proposal.yml b/.github/ISSUE_TEMPLATE/feature_proposal.yml new file mode 100644 index 0000000000000..fc843a7df2d1c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_proposal.yml @@ -0,0 +1,31 @@ +name: 🚀 Feature Proposal +description: Propose a feature +title: "[🚀 Feature]: " +labels: [ feature, needs-triaging ] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to propose a feature! + - type: textarea + id: feature-description + attributes: + label: Feature and motivation + description: | + Describe clearly and concisely the feature you are proposing, what is the motivation + behind it. + 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. + validations: + required: true + - type: textarea + id: feature-example + attributes: + label: Usage example + description: | + How would you use this feature? + placeholder: | + A clear example showing how this feature is useful for you and the Selenium community. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 13b06f64d6942..0000000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,14 +0,0 @@ ---- - -name: 💬 Questions / Help -about: If you have questions, please check our IRC or Slack ---- - -## 💬 Questions and Help - -### Please note that this issue tracker is not a help form and this issue will be closed. - -For questions or help please see: - -- [SeleniumHQ IRC/Slack channel](https://www.selenium.dev/support/) -- [Selenium Users](https://groups.google.com/forum/#!forum/selenium-users) google group diff --git a/.github/ISSUE_TEMPLATE/regression.md b/.github/ISSUE_TEMPLATE/regression.md deleted file mode 100644 index f984255cdaef9..0000000000000 --- a/.github/ISSUE_TEMPLATE/regression.md +++ /dev/null @@ -1,61 +0,0 @@ ---- - -name: 💥 Regression Report -about: Report unexpected behavior that worked in previous versions ---- - -## 💥 Regression Report - -A clear and concise description of what the regression is. - - - -## Last working Selenium version - -Worked up to version: - -Stopped working in version: - -## To Reproduce - - - -Detailed steps to reproduce the behavior: - -## Expected behavior - -A clear and concise description of what you expected to happen. - -## Test script reproducing this issue (when applicable) - -Please provide a test script to reproduce the issue you are reporting, if the -setup is more complex, GitHub repo links with are also OK. - -Issues without a reproduction script are likely to stall and eventually be closed. - -## Environment - -OS: -Browser: -Browser version: -Browser Driver version: -Language Bindings version: -Selenium Grid version (if applicable): diff --git a/.github/selenium-assistant.yml b/.github/selenium-assistant.yml deleted file mode 100644 index 84cc6dfac35eb..0000000000000 --- a/.github/selenium-assistant.yml +++ /dev/null @@ -1,72 +0,0 @@ -# Configuration for selenium assistant - https://github.com/seleniumhq/selenium-assistant - -# Comment to greet any user creating a new issue. Set to `false` to disable -openIssueGreetingComment: > - 👋 Hi there! Thank you for creating this issue. - - - I am the Selenium Assistant Bot 🤖, I triage issues in this repository. - If I can't do it, I label it to help maintainers identify issues that need triaging. - - - I am an Open Source project 🙌, post bugs or ideas [here](https://github.com/SeleniumHQ/selenium-assistant)! - -# Is the assistant actively closing any new open issues requesting support or asking questions? -closeQuestionsAndSupportRequests: true - -# Strings used by the bot to identify that the issue is a request for support or a question? -# If left empty or `false` the bot won't close any support requests or questions -questionsAndSupportRequestsStrings: - - 💬 - - questions and help - -# Comment users get when a support request or question is created as an issue. -closeQuestionsAndSupportRequestsComment: > - 💬 It looks like this is a request for support or a question - - - 💡 A better way to address this is: - - - * 📫 Send questions and support requests to the [Selenium user group](https://groups.google.com/forum/#!forum/selenium-users) - - * 📮 Post them to [StackOverflow](https://stackoverflow.com/questions/tagged/selenium) - - * 🗣 Join us in the [IRC/Slack channel](https://www.selenium.dev/support/) where the community can help you as well - - - If you think this is incorrect, please feel free to open a new issue. - - - -# Issue types that the repo supports. When an issue is created, the heading should be one of these strings -# (from the issue templates). To take into account markdown characters, put the whole string in quotations. -issueTypes: - - "## 🐛 Bug Report" - - "## 🚀 Feature Proposal" - - "## 💥 Regression Report" - -closeNotSupportedIssueTypes: true - -closeNotSupportedIssueTypesComment: > - ❗️ It seems this issue is not using any of the supported templates. This is a volunteer-run project - that receives a lot of issues that do not provide sufficient information needed to provide proper help. - - 💡 Please select which of these best represents your concern, and make sure you provide all of the requested information: - - * 🐛 [Bug Report](https://github.com/SeleniumHQ/selenium/issues/new?template=bug.md) (bugs found in a recent release) - - * 🚀 [Feature Proposal](https://github.com/SeleniumHQ/selenium/issues/new?template=feature.md) (a useful feature you would like to propose) - - * 💥 [Regression Report](https://github.com/SeleniumHQ/selenium/issues/new?template=regression.md) (a supported feature is not working anymore) - - - If you are asking a question, a better way to address this is: - - - * 📫 Send questions and support requests to the [Selenium user group](https://groups.google.com/forum/#!forum/selenium-users) - - * 📮 Post them to [StackOverflow](https://stackoverflow.com/questions/tagged/selenium) - - * 🗣 Join us in the [IRC/Slack channel](https://www.selenium.dev/support/) where the community can help you as well -