From 86c4b97a40fd2712b16533a7136e31dd2b5e0d4d Mon Sep 17 00:00:00 2001 From: ajcvickers Date: Wed, 23 Sep 2020 15:43:47 -0700 Subject: [PATCH] Update issue templates to remove discussions --- .github/ISSUE_TEMPLATE/ask_a_question.md | 52 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report_efcore.md | 39 +++++++++++----- .github/ISSUE_TEMPLATE/bug_report_sqlite.md | 27 ++++++----- .github/ISSUE_TEMPLATE/config.yml | 3 -- 4 files changed, 96 insertions(+), 25 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/ask_a_question.md diff --git a/.github/ISSUE_TEMPLATE/ask_a_question.md b/.github/ISSUE_TEMPLATE/ask_a_question.md new file mode 100644 index 00000000000..c59c5523030 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask_a_question.md @@ -0,0 +1,52 @@ +--- +name: Ask a question +about: Ask a question about Entity Framework Core or Microsoft.Data.Sqlite +labels: customer-reported +--- + +## Please make your question as clear and specific as possible + +### Include your code + +Usually the best way to ask a clear question and get a quick response is to show your code. Preferably, attach a small, runnable project or post a small, runnable code listing that reproduces what you are seeing. + +Use triple-tick code fences for any posted code. For example: + +```C# +Console.WriteLine("Hello, World!"); +``` + +### Include stack traces + +Include the full exception message and stack trace for any exception you encounter. + +Use triple-tick fences for stack traces. For example: + +``` +Unhandled exception. System.NullReferenceException: Object reference not set to an instance of an object. + at SixFour.Sub() in C:\Stuff\AllTogetherNow\SixFour\SixFour.cs:line 49 + at SixFour.Main() in C:\Stuff\AllTogetherNow\SixFour\SixFour.cs:line 54 +``` + +### Include verbose output + +Please include verbose output when asking questions about the `dotnet ef` or Package Manager Console tools. + +Use triple-tick fences for tool output. For example: + +``` +C:\Stuff\AllTogetherNow\FiveOh>dotnet ef dbcontext list --verbose +Using project 'C:\Stuff\AllTogetherNow\FiveOh\FiveOh.csproj'. +... +Finding DbContext classes in the project... +Found DbContext 'BlogContext'. +BlogContext +``` + +### Include provider and version information + +EF Core version: +Database provider: (e.g. Microsoft.EntityFrameworkCore.SqlServer) +Target framework: (e.g. .NET Core 3.0) +Operating system: +IDE: (e.g. Visual Studio 2019 16.3) diff --git a/.github/ISSUE_TEMPLATE/bug_report_efcore.md b/.github/ISSUE_TEMPLATE/bug_report_efcore.md index 8cf528f967c..008a355eb3b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_efcore.md +++ b/.github/ISSUE_TEMPLATE/bug_report_efcore.md @@ -4,29 +4,46 @@ about: Create a report about something that isn't working labels: customer-reported --- - +### Include your code +To fix any bug we mus first reproduce it. To make this possible, please attach a small, runnable project or post a small, runnable code listing that reproduces what you are seeing. +It is often impossible for us to reproduce a bug when working with only code snippets since we have to guess at the missing code. -### Steps to reproduce +Use triple-tick code fences for any posted code. For example: - +Please include `--verbose` output when filing bugs about the `dotnet ef` or Package Manager Console tools. +Use triple-tick fences for tool output. For example: +``` +C:\Stuff\AllTogetherNow\FiveOh>dotnet ef dbcontext list --verbose +Using project 'C:\Stuff\AllTogetherNow\FiveOh\FiveOh.csproj'. +... +Finding DbContext classes in the project... +Found DbContext 'BlogContext'. +BlogContext +``` -### Further technical details +### Include provider and version information EF Core version: Database provider: (e.g. Microsoft.EntityFrameworkCore.SqlServer) diff --git a/.github/ISSUE_TEMPLATE/bug_report_sqlite.md b/.github/ISSUE_TEMPLATE/bug_report_sqlite.md index 842b51541e6..072e8359448 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_sqlite.md +++ b/.github/ISSUE_TEMPLATE/bug_report_sqlite.md @@ -4,28 +4,33 @@ about: Create a report about something that isn't working labels: area-adonet-sqlite, customer-reported --- - +### Include your code +To fix any bug we mus first reproduce it. To make this possible, please attach a small, runnable project or post a small, runnable code listing that reproduces what you are seeing. +It is often impossible for us to reproduce a bug when working with only code snippets since we have to guess at the missing code. -### To Reproduce +Use triple-tick code fences for any posted code. For example: - +### Include stack traces + +Include the full exception message and stack trace for any exception you encounter. +Use triple-tick fences for stack traces. For example: +``` +Unhandled exception. System.NullReferenceException: Object reference not set to an instance of an object. + at SixFour.Sub() in C:\Stuff\AllTogetherNow\SixFour\SixFour.cs:line 49 + at SixFour.Main() in C:\Stuff\AllTogetherNow\SixFour\SixFour.cs:line 54 +``` -### Additional context +### Include version information Microsoft.Data.Sqlite version: Target framework: (e.g. .NET Core 3.0) Operating system: + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5577dafc1a0..c7b94dc25da 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,5 @@ blank_issues_enabled: true contact_links: - - name: Got a question? - url: https://github.com/dotnet/efcore/discussions/new - about: Please use discussions to ask a question about using the product. - name: Issue with ASP.NET Core url: https://github.com/dotnet/aspnetcore/issues/new/choose about: Please open issues relating to ASP.NET Core in dotnet/aspnetcore.