Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 3.13 KB
Raw

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Contributor Getting Started

SQL Setup

In order to test changes it is suggested that you have a SQL server set up to connect to and run queries against. Instructions to set this up can be found in the Quick Start Guide

Set Up Development Environment

  1. Install VS Code

  2. Clone repo and open in VS Code:

    git clone https://github.com/Azure/azure-functions-sql-extension
cd azure-functions-sql-extension
code .

  3. Install extensions when prompted after VS Code opens

    • Note: This includes the Azure Functions, C#, and editorconfig extensions

  4. Configure the Function App located in the samples folder by following the instructions here

  5. Configure a local nuget source that will be used to build the .NET Out-of-Proc sample with the latest locally built extension package.

    Building the sample will cause a project to be created and built in the temp directory, which means it does not pick up on the nuget.config for this project. Without adding the source at the global level that project will fail to build since it will be looking for the dev-local version of the package (99.99.99).

    Note: This command must be ran from your home directory (or a directory outside the project repo).

    dotnet nuget add source <PATH_TO_REPO_AZURE-FUNCTIONS-SQL-EXTENSION/local-packages>

  6. Press F5 to run SQL bindings samples that are included in this repo. The output window should display startup information as well as the function endpoints that were started.

Development Notes

JSON Serialization/Deserialization

We currently use the Newtonsoft library for all JSON Serialization/Deserialization. This library allows setting global defaults to use when using methods such as JsonConvert.SerializeObject or JsonConvert.DeserializeObject. In order to avoid issues with a user function or other extension setting these default values to something we don't expect ALL serialization/deserialization must be done through the JsonSerializeObject or JsonDeserializeObject methods in the Utils class. These avoid using the default global settings to ensure that the same settings are used no matter what.