Skip to content

Commit 832e8da

Browse files
paulmedynskipaulmedynski
authored
MDS Review Process (#3349)
1 parent dc1298a commit 832e8da

File tree

6 files changed

+330
-118
lines changed

6 files changed

+330
-118
lines changed

‎.github/PULL_REQUEST_TEMPLATE/pr-template.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Description
2+
3+
Provide a summary of the changes being introduced. Important topics to cover
4+
include:
5+
6+
- Description of the functionality.
7+
- API changes, backwards compatibility, deprecations, etc.
8+
- Documentation, localization.
9+
- Bug fixes.
10+
- Code hygiene, refactoring, improvements.
11+
- Engineering processes (CI, pipelines, test coverage)
12+
13+
High quality descriptions will lead to a smoother review experience.
14+
15+
## Issues
16+
17+
Link to any relevant issues, bugs, or discussions (e.g., "Closes \#123", "Fixes
18+
issue \#456").
19+
20+
## Testing
21+
22+
Describe the automated tests (unit, integration) you created or modified.
23+
Provide justification for any gap in automated testing. List any manual testing
24+
steps that were performed to ensure the changes work. 
25+
26+
## Guidelines
27+
28+
Please review the contribution guidelines before submitting a pull request:
29+
30+
- [Contributing](/CONTRIBUTING.md)
31+
- [Code of Conduct](/CODE_OF_CONDUCT.md)
32+
- [Best Practices](/policy/coding-best-practices.md)
33+
- [Coding Style](/policy/coding-style.md)
34+
- [Review Process](/policy/review-process.md)

‎CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Please do:
2424
- **DO** report each issue as a new issue (but check first if it's already been reported)
2525
- **DO** respect Issue Templates and provide detailed information. It will make the process to reproduce the issue and provide a fix faster.
2626
- **DO** provide a minimal repro app demonstrating the problem in isolation will greatly speed up the process of identifying and fixing problems.
27-
- **DO** follow our [coding style](coding-style.md) (C# code-specific) when working on a Pull Request.
27+
- **DO** follow our [coding style](/policy/coding-style.md) (C# code-specific) when working on a Pull Request.
2828
- **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines.
2929
- **DO** consider cross-platform compatibility and supportability for all supported SQL and Azure Servers and client configurations.
3030
- **DO** include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.

‎README.md

Lines changed: 119 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,119 @@
1-
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
2-
[![Nuget](https://img.shields.io/nuget/dt/Microsoft.Data.SqlClient?label=Nuget.org%20Downloads&style=flat-square&color=blue)](https://www.nuget.org/packages/Microsoft.Data.SqlClient)
3-
[![Build status](https://sqlclientdrivers.visualstudio.com/public/_apis/build/status/ADO/CI-SqlClient)](https://sqlclientdrivers.visualstudio.com/public/_build/latest?definitionId=1879)
4-
5-
# Microsoft SqlClient Data Provider for SQL Server
6-
7-
Microsoft.Data.SqlClient is a .NET data provider for [Microsoft SQL Server]([url](https://aka.ms/sql)) and the [Azure SQL]([url](https://aka.ms/azure_sql)) family of databases. It grew from a union of the two System.Data.SqlClient components which live independently in .NET Framework and .NET Core. Going forward, support for new SQL Server and Azure SQL features will only be implemented in Microsoft.Data.SqlClient.
8-
9-
## Supportability
10-
11-
The Microsoft.Data.SqlClient package supports the following environments:
12-
13-
- .NET Framework 4.6.2+
14-
- .NET 8.0+
15-
16-
## Download
17-
18-
The Microsoft.Data.SqlClient NuGet package is available on [NuGet.org](https://www.nuget.org/packages/Microsoft.Data.SqlClient/).
19-
20-
## SNI Package References
21-
22-
When targeting .NET Framework on Windows, a package reference to [Microsoft.Data.SqlClient.SNI](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI/) loads native `Microsoft.Data.SqlClient.SNI.<platform>.dll` libraries into the client's build directories.
23-
24-
When targeting .NET on Windows, a package reference to [Microsoft.Data.SqlClient.SNI.runtime](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI.runtime/) loads `arm64`, `x64` and `x86` native `Microsoft.Data.SqlClient.SNI.dll` libraries into subdirectories in the client's build directory.
25-
26-
## Helpful Links
27-
28-
| Topic | Link to File |
29-
| :---- | :------------- |
30-
| Coding Style | [coding-style.md](coding-style.md) |
31-
| Guidelines for building the driver | [BUILDGUIDE.md](BUILDGUIDE.md) |
32-
| Guidelines for Contributors | [CONTRIBUTING.md](CONTRIBUTING.md) |
33-
| Changelog for all driver releases | [CHANGELOG.md](CHANGELOG.md) |
34-
| Support Policy | [SUPPORT.md](SUPPORT.md) |
35-
| Code of Conduct | [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) |
36-
| Copyright Information | [COPYRIGHT.md](COPYRIGHT.md) |
37-
38-
## Our Featured Contributors
39-
40-
Special thanks to everyone who has contributed to the project.
41-
We thank you for your continuous support in improving the SqlClient library!
42-
43-
- Edward Neal ([@edwardneal](https://github.com/edwardneal))
44-
- Erik Ejlskov Jensen ([@ErikEJ](https://github.com/ErikEJ))
45-
- Michel Zehnder ([@MichelZ](https://github.com/MichelZ))
46-
- Shay Rojansky ([@roji](https://github.com/roji))
47-
- Phillip Haydon ([@phillip-haydon](https://github.com/phillip-haydon))
48-
- Rasmus Melchior Jacobsen ([@rmja](https://github.com/rmja))
49-
- Robin Sue ([@Suchiman](https://github.com/Suchiman))
50-
- Simon Cropp ([@SimonCropp](https://github.com/SimonCropp))
51-
- Stefán Jökull Sigurðarson ([@stebet](https://github.com/stebet))
52-
- Stephen Toub ([@stephentoub](https://github.com/stephentoub))
53-
- Wraith ([@Wraith2](https://github.com/Wraith2))
54-
55-
Up-to-date list of contributors: [Contributor Insights](https://github.com/dotnet/SqlClient/graphs/contributors)
56-
57-
## Release Notes
58-
59-
All preview and stable driver release notes are available under [release-notes](release-notes).
60-
61-
## Porting from System.Data.SqlClient
62-
63-
Refer to [porting-cheat-sheet.md](porting-cheat-sheet.md) for a safe porting experience from System.Data.SqlClient to Microsoft.Data.SqlClient and share your experience with us by enhancing this guide for future developers.
64-
65-
## Still have questions?
66-
67-
Check out our [FAQ](https://github.com/dotnet/SqlClient/wiki/Frequently-Asked-Questions). Still not answered? Create an [issue](https://github.com/dotnet/SqlClient/issues/new/choose) to ask a question.
68-
69-
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.3 BLOCK -->
70-
71-
## Security
72-
73-
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
74-
75-
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
76-
77-
## Reporting Security Issues
78-
79-
**Please do not report security vulnerabilities through public GitHub issues.**
80-
81-
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
82-
83-
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
84-
85-
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
86-
87-
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
88-
89-
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
90-
* Full paths of source file(s) related to the manifestation of the issue
91-
* The location of the affected source code (tag/branch/commit or direct URL)
92-
* Any special configuration required to reproduce the issue
93-
* Step-by-step instructions to reproduce the issue
94-
* Proof-of-concept or exploit code (if possible)
95-
* Impact of the issue, including how an attacker might exploit the issue
96-
97-
This information will help us triage your report more quickly.
98-
99-
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
100-
101-
## Preferred Languages
102-
103-
We prefer all communications to be in English.
104-
105-
## Policy
106-
107-
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
108-
109-
<!-- END MICROSOFT SECURITY.MD BLOCK -->
110-
111-
## License
112-
113-
The Microsoft.Data.SqlClient Driver for SQL Server is licensed under the MIT license. See the [LICENSE](LICENSE) file for more details.
114-
115-
## Trademarks
116-
117-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
1+
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
2+
[![Nuget](https://img.shields.io/nuget/dt/Microsoft.Data.SqlClient?label=Nuget.org%20Downloads&style=flat-square&color=blue)](https://www.nuget.org/packages/Microsoft.Data.SqlClient)
3+
[![Build status](https://sqlclientdrivers.visualstudio.com/public/_apis/build/status/ADO/CI-SqlClient)](https://sqlclientdrivers.visualstudio.com/public/_build/latest?definitionId=1879)
4+
5+
# Microsoft SqlClient Data Provider for SQL Server
6+
7+
Microsoft.Data.SqlClient is a .NET data provider for [Microsoft SQL Server]([url](https://aka.ms/sql)) and the [Azure SQL]([url](https://aka.ms/azure_sql)) family of databases. It grew from a union of the two System.Data.SqlClient components which live independently in .NET and .NET Framework. Going forward, support for new SQL Server and Azure SQL features will only be implemented in Microsoft.Data.SqlClient.
8+
9+
## Supportability
10+
11+
The Microsoft.Data.SqlClient package supports the following environments:
12+
13+
- .NET Framework 4.6.2+
14+
- .NET 8.0+
15+
16+
## Download
17+
18+
The Microsoft.Data.SqlClient NuGet package is available on [NuGet.org](https://www.nuget.org/packages/Microsoft.Data.SqlClient/).
19+
20+
## SNI Package References
21+
22+
When targeting .NET Framework on Windows, a package reference to [Microsoft.Data.SqlClient.SNI](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI/) loads native `Microsoft.Data.SqlClient.SNI.<platform>.dll` libraries into the client's build directories.
23+
24+
When targeting .NET on Windows, a package reference to [Microsoft.Data.SqlClient.SNI.runtime](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI.runtime/) loads `arm64`, `x64` and `x86` native `Microsoft.Data.SqlClient.SNI.dll` libraries into subdirectories in the client's build directory.
25+
26+
## Helpful Links
27+
28+
| Topic | Link to File |
29+
| :---- | :------------- |
30+
| Coding Style | [coding-style.md](/policy/coding-style.md) |
31+
| Best Practices | [coding-best-practices.md](/policy/coding-best-practices.md) |
32+
| Review Process | [review-process.md](/policy/review-process.md) |
33+
| Guidelines for building the driver | [BUILDGUIDE.md](BUILDGUIDE.md) |
34+
| Guidelines for Contributors | [CONTRIBUTING.md](CONTRIBUTING.md) |
35+
| Changelog for all driver releases | [CHANGELOG.md](CHANGELOG.md) |
36+
| Support Policy | [SUPPORT.md](SUPPORT.md) |
37+
| Code of Conduct | [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) |
38+
| Copyright Information | [COPYRIGHT.md](COPYRIGHT.md) |
39+
40+
## Our Featured Contributors
41+
42+
Special thanks to everyone who has contributed to the project.
43+
We thank you for your continuous support in improving the SqlClient library!
44+
45+
- Edward Neal ([@edwardneal](https://github.com/edwardneal))
46+
- Erik Ejlskov Jensen ([@ErikEJ](https://github.com/ErikEJ))
47+
- Michel Zehnder ([@MichelZ](https://github.com/MichelZ))
48+
- Shay Rojansky ([@roji](https://github.com/roji))
49+
- Phillip Haydon ([@phillip-haydon](https://github.com/phillip-haydon))
50+
- Rasmus Melchior Jacobsen ([@rmja](https://github.com/rmja))
51+
- Robin Sue ([@Suchiman](https://github.com/Suchiman))
52+
- Simon Cropp ([@SimonCropp](https://github.com/SimonCropp))
53+
- Stefán Jökull Sigurðarson ([@stebet](https://github.com/stebet))
54+
- Stephen Toub ([@stephentoub](https://github.com/stephentoub))
55+
- Wraith ([@Wraith2](https://github.com/Wraith2))
56+
57+
Up-to-date list of contributors: [Contributor Insights](https://github.com/dotnet/SqlClient/graphs/contributors)
58+
59+
## Release Notes
60+
61+
All preview and stable driver release notes are available under [release-notes](release-notes).
62+
63+
## Porting from System.Data.SqlClient
64+
65+
Refer to [porting-cheat-sheet.md](porting-cheat-sheet.md) for a safe porting experience from System.Data.SqlClient to Microsoft.Data.SqlClient and share your experience with us by enhancing this guide for future developers.
66+
67+
## Still have questions?
68+
69+
Check out our [FAQ](https://github.com/dotnet/SqlClient/wiki/Frequently-Asked-Questions). Still not answered? Create an [issue](https://github.com/dotnet/SqlClient/issues/new/choose) to ask a question.
70+
71+
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.3 BLOCK -->
72+
73+
## Security
74+
75+
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
76+
77+
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://www.microsoft.com/en-us/msrc/definition-of-a-security-vulnerability), please report it to us as described below.
78+
79+
## Reporting Security Issues
80+
81+
**Please do not report security vulnerabilities through public GitHub issues.**
82+
83+
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
84+
85+
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
86+
87+
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
88+
89+
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
90+
91+
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
92+
- Full paths of source file(s) related to the manifestation of the issue
93+
- The location of the affected source code (tag/branch/commit or direct URL)
94+
- Any special configuration required to reproduce the issue
95+
- Step-by-step instructions to reproduce the issue
96+
- Proof-of-concept or exploit code (if possible)
97+
- Impact of the issue, including how an attacker might exploit the issue
98+
99+
This information will help us triage your report more quickly.
100+
101+
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
102+
103+
## Preferred Languages
104+
105+
We prefer all communications to be in English.
106+
107+
## Policy
108+
109+
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
110+
111+
<!-- END MICROSOFT SECURITY.MD BLOCK -->
112+
113+
## License
114+
115+
The Microsoft.Data.SqlClient Driver for SQL Server is licensed under the MIT license. See the [LICENSE](LICENSE) file for more details.
116+
117+
## Trademarks
118+
119+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

0 commit comments

Comments
 (0)