From 18cc7439efb034e48076ed3d7361c46e17373bdd Mon Sep 17 00:00:00 2001 From: Brian Chavez Date: Fri, 22 Dec 2023 11:05:19 -0700 Subject: [PATCH] Update GitHub Bug Template. //skipci --- .github/ISSUE_TEMPLATE/01_support.md | 28 --- .github/ISSUE_TEMPLATE/02_feature_request.md | 29 --- .github/ISSUE_TEMPLATE/03_bug_report.md | 34 ---- .github/ISSUE_TEMPLATE/bug_report.yml | 185 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 + 5 files changed, 187 insertions(+), 91 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/01_support.md delete mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/03_bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/01_support.md b/.github/ISSUE_TEMPLATE/01_support.md deleted file mode 100644 index 93bc329d..00000000 --- a/.github/ISSUE_TEMPLATE/01_support.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: ❓ Support -labels: question -about: If you need help using Bogus 🏥 ---- - -### Version Information -| Software | Version(s) | -| ------------------------| ---------- | -| Bogus NuGet Package | | -| .NET Core? | | -| .NET Full Framework? | | -| Windows OS? | | -| Linux OS? | | -| Visual Studio? | | - -### What locale are you using with Bogus? - -### What's the problem? - -### What possible solutions have you considered? - -### Do you have sample code to show what you're trying to do? - -_(Please be complete. Provide all code necessary to run your example in LINQPad.)_ -_(The more complete code examples are, the more accurate answers will be.)_ -_(https://www.linqpad.net)_ - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md deleted file mode 100644 index 4ac0e396..00000000 --- a/.github/ISSUE_TEMPLATE/02_feature_request.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: 🚀 Feature request -about: If you have a feature request 💡 ---- - -### Please describe why you are requesting a feature - - -### Please provide a code example of what you are trying to achieve - -_(Please be complete. Include all code necessary to run your example in LINQPad.)_ -_(The more complete code examples are, the more accurate answers will be.)_ -_(https://www.linqpad.net)_ - - -### Please answer any or all of the questions below - -* Is the feature something that currently cannot be done? - - -* What alternatives have you considered? - - -* Has the feature been requested in the past? - - -**If the feature request is approved, would you be willing to submit a PR?** - -Yes / No _(Help can be provided if you need assistance submitting a PR)_ diff --git a/.github/ISSUE_TEMPLATE/03_bug_report.md b/.github/ISSUE_TEMPLATE/03_bug_report.md deleted file mode 100644 index e41acc1a..00000000 --- a/.github/ISSUE_TEMPLATE/03_bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: 🐜 Bug report -about: If something isn't working 🔧 ---- - -### Version Information -| Software | Version(s) | -| ------------------------| ---------- | -| Bogus NuGet Package | | -| .NET Core? | | -| .NET Full Framework? | | -| Windows OS? | | -| Linux OS? | | -| Visual Studio? | | - -### What locale are you using with Bogus? - -### What is the expected behavior? - -### What is the actual behavior? - -### Please provide a stack trace. - -### Any possible solutions? - -### How do you reproduce the issue? - -### Do you have a unit test that can demonstrate the bug? - -### Can you identify the location in Bogus' source code where the problem exists? - -### If the bug is confirmed, would you be willing to submit a PR? - -Yes or No? diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..6ea0df85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,185 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug", "triage"] +projects: ["bchavez/Bogus"] +assignees: + - bchavez +body: + - type: markdown + attributes: + value: | + ## Version Information + + - type: input + id: version-bogus + attributes: + label: Bogus NuGet Package + description: What version of Bogus are you using? + placeholder: ex. v35.0.1 + validations: + required: true + + - type: input + id: version-dotnet + attributes: + label: .NET Version + description: What version of .NET are using? + placeholder: ex. Full Framework 4.7.1 or .NET 8? + validations: + required: true + + - type: input + id: version-visualstudio + attributes: + label: Visual Studio Version + description: What version of Visual Studio are using? + placeholder: ex. 17.8? + validations: + required: false + + - type: dropdown + id: operating-system + attributes: + label: What operating system are you using? + multiple: false + options: + - Windows + - Linux + - MacOS + - Other + validations: + required: true + + - type: markdown + attributes: + value: | + ## Report + + - type: input + id: bogus-locale + attributes: + label: What locale are you using with Bogus? + description: + placeholder: ex. en_GB + validations: + required: true + + + - type: textarea + id: problem-description + attributes: + label: Problem Description + description: Please share a clear and concise description of the problem. + placeholder: + validations: + required: true + + - type: textarea + id: problem-linqpad-repro-steps + attributes: + label: LINQPad Example or Reproduction Steps + description: | + Please provide a LINQPad example of the problem or provide reproduction steps. LINQPad can be downloaded here: https://www.linqpad.net/. + placeholder: "LINQPad can be downloaded here: https://www.linqpad.net/" + validations: + required: true + + - type: textarea + id: bogus-expected-behavior + attributes: + label: Expected Behavior + description: | + Provide a description of the expected behavior. + placeholder: Expected Behavior + validations: + required: true + + - type: textarea + id: bogus-actual-behavior + attributes: + label: Actual Behavior + description: | + Provide a description of the actual behavior observed. Please include any error messages, exception stacktraces, logs, and/or screenshots. + placeholder: Actual Behavior + validations: + required: true + + - type: textarea + id: known-workarounds + attributes: + label: Known Workarounds + description: | + Please provide a description of any known workarounds. + placeholder: Known Workarounds + validations: + required: false + + - type: dropdown + id: pull-request + attributes: + label: Could you help with a pull-request? + description: If the bug is confirmed, would you be willing to submit a pull-request?. + options: + - "No" + - "Yes" + validations: + required: true + + + + + + + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 1.0.2 (Default) + - 1.0.3 (Edge) + default: 0 + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..b92c70cb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +blank_issues_enabled: true +