Merge main

Author: edwardneal

.config/tsaoptions.json

@@ -7,7 +7,7 @@
     "repositoryName": "SqlClient",
     "codebaseName": "SqlClient",
     "allTools": true,
-    "template": "MSDATA_RevolutionR",
+    "template": "MSDATA_RevolutionR_Overloaded0",
     "language": "csharp",
     "includePathPatterns": "src/Microsoft.Data.SqlClient/*, src/Microsoft.SqlServer.Server/*, tools/*",
     "excludePathPatterns": "src/Microsoft.Data.SqlClient/tests/*"

.github/CODEOWNERS

@@ -0,0 +1,25 @@
+#==============================================================================
+# This is the global GitHub code owners file for the SqlClient repo.  No other
+# CODEOWNERS files should exist in the repo.
+#
+# Code owners documentation is here:
+#
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+# The entire repo is owned by the SqlClientDevTeam GitHub team:
+#
+# https://github.com/orgs/dotnet/teams/sqlclientdevteam
+#
+# This team must be configured with write access to the repo for code ownership
+# rules to apply.
+#
+# The main branch should also be protected and require all PRs to be approved
+# by owners.  See:
+#
+# https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging
+#
+# There should be no other owners specified in the repo.
+#
+* @dotnet/sqlclientdevteam
+
+#==============================================================================

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,9 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: 'Triage Needed'
-assignees: ''
+title: ""
+labels: [":new: Triage Needed", ":bug: Bug!"]
+assignees: []
 
 ---
 
@@ -31,9 +31,9 @@ A clear and concise description of what you expected to happen.
 
 ### Further technical details
 Microsoft.Data.SqlClient version: (found on the nuget or Microsoft.Data.SqlClient.dll)
-.NET target: (e.g. Framework 4.7.1, Core 2.2.2)
-SQL Server version: (e.g. SQL Server 2017)
-Operating system: (e.g. Windows 2019, Ubuntu 18.04, macOS 10.13, Docker container)
+.NET target: (e.g. .NET Framework 4.7.2, .NET 6.0)
+SQL Server version: (e.g. SQL Server 2022)
+Operating system: (e.g. Windows Server 2022, Ubuntu 24.04, macOS 14.7.1, Docker container)
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: SqlClient Community Support / Discussions
+    url: https://github.com/dotnet/SqlClient/discussions
+    about: Please ask and answer questions here.
+  - name: MSRC Vulnerability Reporting / Bug Bounty
+    url: https://msrc.microsoft.com/create-report
+    about: Please report security vulnerabilities here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,9 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: 'Triage Needed'
-assignees: ''
+title: ""
+labels: [":new: Triage Needed", ":bulb: Enhancement"]
+assignees: []
 
 ---
 
@@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
 A clear and concise description of any alternative solutions or features you've considered.
 
 ### Additional context
-Add any other context about the feature request here.
+Add any other context about the feature request here.

.github/ISSUE_TEMPLATE/other.md

@@ -1,10 +1,8 @@
 ---
 name: Other
 about: Ask a question or file a different type of issue
-title: ''
-labels: 'Triage Needed'
-assignees: ''
-
----
-
+title: ""
+labels: [":new: Triage Needed"]
+assignees: []
 
+---

.github/pull_request_template.md

@@ -0,0 +1,34 @@
+## Description
+
+Provide a summary of the changes being introduced. Important topics to cover
+include:
+
+- Description of the functionality.
+- API changes, backwards compatibility, deprecations, etc.
+- Documentation, localization.
+- Bug fixes.
+- Code hygiene, refactoring, improvements.
+- Engineering processes (CI, pipelines, test coverage)
+
+High quality descriptions will lead to a smoother review experience.
+
+## Issues
+
+Link to any relevant issues, bugs, or discussions (e.g., "Closes \#123", "Fixes
+issue \#456").
+
+## Testing
+
+Describe the automated tests (unit, integration) you created or modified.
+Provide justification for any gap in automated testing.  List any manual testing
+steps that were performed to ensure the changes work.  
+
+## Guidelines
+
+Please review the contribution guidelines before submitting a pull request:
+
+- [Contributing](/CONTRIBUTING.md)
+- [Code of Conduct](/CODE_OF_CONDUCT.md)
+- [Best Practices](/policy/coding-best-practices.md)
+- [Coding Style](/policy/coding-style.md)
+- [Review Process](/policy/review-process.md)

BUILDGUIDE.md

@@ -30,6 +30,7 @@ Once the environment is setup properly, execute the desired set of commands belo
 |`RunTests`|Runs the functional and manual tests for the .NET Framework and .NET drivers|
 |`RunFunctionalTests`|Runs just the functional tests for the .NET Framework and .NET drivers|
 |`RunManualTests`|Runs just the manual tests for the .NET Framework and .NET drivers|
+|`BuildAkv`|Builds the Azure Key Vault Provider package for all supported platforms.|
 
 
 ### Parameters
@@ -306,7 +307,7 @@ To run the same:
     The program 'dotnet' has exited with code 0 (0x0).
     ```
 
-5. Now you can write code in [Program.cs](/src/Microsoft.Data.SqlClient/tests/DockerLinuxTest/Program.cs) to debug SqlClient on Linux!
+5. Now you can write code in [Program.cs](/src/Microsoft.Data.SqlClient/tests/Docker/DockerLinuxTest/Program.cs) to debug SqlClient on Linux!
 
 ### Troubleshooting Docker issues
 
@@ -338,14 +339,118 @@ dotnet test <test_properties...> --collect:"XPlat Code Coverage"
 
 ## Run Performance Tests
 
-### Running Performance test project directly
+The performance tests live here:
+`src\Microsoft.Data.SqlClient\tests\PerformanceTests\`
 
-Project location from Root: `src\Microsoft.Data.SqlClient\tests\PerformanceTests\Microsoft.Data.SqlClient.PerformanceTests.csproj`
-Configure `runnerconfig.json` file with connection string and preferred settings to run Benchmark Jobs.
+They can be run from the command line by following the instructions below.
+
+Launch a shell and change into the project directory:
+
+PowerShell:
+
+```pwsh
+> cd src\Microsoft.Data.SqlClient\tests\PerformanceTests
+```
+
+Bash:
+
+```bash
+$ cd src/Microsoft.Data.SqlClient/tests/PerformanceTests
+```
+
+### Create Database
+
+Create an empty database for the benchmarks to use.  This example assumes
+a local SQL server instance using SQL authentication:
 
 ```bash
-cd src\Microsoft.Data.SqlClient\tests\PerformanceTests
-dotnet run -c Release -f net8.0
+$ sqlcmd -S localhost -U sa -P password
+1> create database [sqlclient-perf-db]
+2> go
+1> quit
+```
+
+The default `runnerconfig.json` expects a database named `sqlclient-perf-db`,
+but you may change the config to use any existing database.  All tables in
+the database will be dropped when running the benchmarks.
+
+### Configure Runner
+
+Configure the benchmarks by editing the `runnerconfig.json` file directly in the
+`PerformanceTests` directory with an appropriate connection string and benchmark
+settings:
+
+```json
+{
+  "ConnectionString": "Server=tcp:localhost; Integrated Security=true; Initial Catalog=sqlclient-perf-db;",
+  "UseManagedSniOnWindows": false,
+  "Benchmarks":
+  {
+    "SqlConnectionRunnerConfig":
+    {
+      "Enabled": true,
+      "LaunchCount": 1,
+      "IterationCount": 50,
+      "InvocationCount":30,
+      "WarmupCount": 5,
+      "RowCount": 0
+    },
+    ...
+  }
+}
 ```
 
-_Only "**Release** Configuration" applies to Performance Tests_
+Individual benchmarks may be enabled or disabled, and each has several
+benchmarking options for fine tuning.
+
+After making edits to `runnerconfig.json` you must perform a build which will
+copy the file into the `artifacts` directory alongside the benchmark DLL.  By
+default, the benchmarks look for `runnerconfig.json` in the same directory as
+the DLL.
+
+Optionally, to avoid polluting your git workspace and requring a build after
+each config change, copy `runnerconfig.json` to a new file, make your edits
+there, and then specify the new file with the RUNNER_CONFIG environment
+variable.
+
+PowerShell:
+
+```pwsh
+> copy runnerconfig.json $HOME\.configs\runnerconfig.json
+
+# Make edits to $HOME\.configs\runnerconfig.json
+
+# You must set the RUNNER_CONFIG environment variable for the current shell.
+> $env:RUNNER_CONFIG="${HOME}\.configs\runnerconfig.json"
+```
+
+Bash:
+
+```bash
+$ cp runnerconfig.json ~/.configs/runnerconfig.json
+
+# Make edits to ~/.configs/runnerconfig.json
+
+# Optionally export RUNNER_CONFIG.
+$ export RUNNER_CONFIG=~/.configs/runnerconfig.json
+```
+
+### Run Benchmarks
+
+All benchmarks must be compiled and run in **Release** configuration.
+
+PowerShell:
+
+```pwsh
+> dotnet run -c Release -f net9.0
+```
+
+Bash:
+
+```bash
+# Omit RUNNER_CONFIG if you exported it earlier, or if you're using the
+# copy prepared by the build.
+$ dotnet run -c Release -f net9.0
+
+$ RUNNER_CONFIG=~/.configs/runnerconfig.json dotnet run -c Release -f net9.0
+```