Skip to content

Commit

Permalink
Minor edits to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
David-Engel authored Aug 28, 2019
1 parent 2ddf3a3 commit 5483d30
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,33 @@ The Microsoft.Data.SqlClient NuGet package is available on [NuGet.org](https://w

## SNI Package References

For NetFx driver on Windows, package reference of [Microsoft.Data.SqlClient.SNI](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI/) loads `x64` and `x86` platform specific `SNI.dll` libraries in client's build directories.
For the .NET Framework driver on Windows, a package reference to [Microsoft.Data.SqlClient.SNI](https://www.nuget.org/packages/Microsoft.Data.SqlClient.SNI/) loads `x64` and `x86` platform specific `SNI.dll` libraries into the client's build directories.

For NetCore driver on Windows, package reference of [runtime.native.System.Data.SqlClient.sni](https://www.nuget.org/packages/runtime.native.System.Data.SqlClient.sni/) loads `arm64`, `x64` and `x86` platform specific `SNI.dll` libraries in client's build directories.
For the .NET Core driver on Windows, a package reference to [runtime.native.System.Data.SqlClient.sni](https://www.nuget.org/packages/runtime.native.System.Data.SqlClient.sni/) loads `arm64`, `x64` and `x86` platform specific `SNI.dll` libraries into the client's build directories.

## Building Driver
## Building the Driver

All necessary details and commands for building driver and running tests are available in [BUILDGUIDE.md](BUILDGUIDE.md).
All necessary details and commands for building the driver and running tests are available in the [BUILDGUIDE](BUILDGUIDE.md).

## Release Notes

All preview and stable driver release notes are available under [release-notes](release-notes).

## Guidelines for Creating Pull Requests

We love contributions from the community. To help improve the quality of our code, we encourage you to follow below guidelines:
We love contributions from the community. To help improve the quality of our code, we encourage you to follow these guidelines:

- Code changes must adhere to [C# Programming Guide](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/index).
- Code changes must adhere to the [C# Programming Guide](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/index).
- Driver code changes must be done considering cross-platform compatibility and supportability for all supported SQL and Azure Servers and client configurations.
- Tests must be added is non-existent to assure near to 100% code coverage for all future changes.
- Tests should be well structured and written well to be able to run in parallel using same client and server configurations (in an isolated mode). E.g. Consider using dynamic table/database object names instead of hardcoded values (Use existing tests for reference).
- Written tests should not leave any residue on target server. Cleaning up all objects is highly appreciated to maintain test server health.
- Tests must be added if non-existent to assure near to 100% code coverage for all future changes.
- Tests should be well structured and written well to be able to run in parallel using the same client and server configurations (in an isolated mode). E.g. Consider using dynamic table/database object names instead of hardcoded values (Use existing tests for reference).
- Tests should not leave any artifacts on the target server. Cleaning up all objects is highly appreciated to maintain test server health.
- Avoid skipping tests if possible or running them conditionally. If conditions are not met, test coverage will not be 100%.

Thank you!

## Guidelines for Reporting Issues

We appreciate you taking the time to test the driver, provide feedback and report any issues. It would be extremely helpful if you:

- Report each issue as a new issue (but check first if it's already been reported)
Expand All @@ -57,18 +58,20 @@ We appreciate you taking the time to test the driver, provide feedback and repor
* Environment details: e.g. .NET Framework / .NET Core version, client operating system
* Table schema (for some issues the data types make a big difference!)
* Any other relevant information you want to share
- Try to provide a repro app demonstrating the isolated problem is possible.
- Providing a minimal repro app demonstrating the problem in isolation will greatly speed up the process of identifying and fixing problems.

Thank you!

## Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) [secure@microsoft.com](mailto:secure@microsoft.com). 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. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/ff852094.aspx).

## Still have questions?

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.

## License

The Microsoft.Data.SqlClient Driver for SQL Server is licensed under the MIT license. See the [LICENSE](https://github.com/dotnet/SqlClient/blob/master/LICENSE) file for more details.

## Code of conduct
Expand Down

0 comments on commit 5483d30

Please sign in to comment.