How to contribute to Privy Unity SDK

For questions or support, email support@privy.io.

Code style & formatting

We use dotnet format together with an .editorconfig file to enforce consistent C# style and catch simple linting issues. A few rules worth highlighting:

• dotnet_style_prefer_auto_properties = true – always prefer auto‑properties to manually backed fields.
• csharp_style_expression_bodied_methods = true – use expression bodies for short methods.* Naming rules enforce PascalCase for enums, types, constants and public members, and I prefix for interfaces.

The .editorconfig in the repo contains additional options; see the Microsoft code style documentation for a complete list.

Set up the pre-commit hook (auto-formats staged files on every commit):

git config core.hooksPath .githooks

Format manually:

dotnet format Format.csproj

Check without modifying files:

dotnet format Format.csproj --verify-no-changes

Native Plugins

If you are working with native platform plugins (e.g. iOS Objective-C), see docs/native-code.md for detailed guidance on bridging native and managed code.

Setting Up and Running the Sample App

1. Clone Repo

     git clone https://github.com/privy-io/unity-sdk.git

2. Open Unity Hub

3. Add the Sample App Project.

   • In Unity Hub, select the Add button to add a new project.
   • Navigate to the unity-sdk/SampleApp directory and select this project.

4. Select the Sample Scene.

   • In the Unity Editor, locate the Project window.
   • Navigate to the Assets > Scenes folder.
   • Double-click the SampleScene file to open it.

5. Run the Scene.

   • Once the sample scene is open, press the Play button at the top of the Unity Editor to run the scene.
   • This will launch the sample app within the Unity Editor, allowing you to test the SDK functionality.