Contributing Setup

Required Software

The requirements to setup, develop, and build this project are listed below.

.NET Runtime

.NET SDK 8.0 or newer

https://dotnet.microsoft.com/en-us/download/dotnet/8.0
See global.json file for specific SDK requirements

Node.js Runtime

Node.js 20.10.0 or newer
NVM for Windows to manage multiple installed versions of Node.js
See engines in the solution package.json for specific version requirements

C# Editor

VS Code
Visual Studio
Rider

Database

SQL Server 2022 or newer compatible database

SQL Editor

MS SQL Server Management Studio
Azure Data Studio

Development Workflow

Create a new branch with one of the following prefixes
- refactor/ - for restructuring of existing features
- fix/ - for bugfixes
Run dotnet format against the Xperience.Kickstart solution

use dotnet: format VS Code task.
Commit changes, with a commit message preferably following the Conventional Commits convention.
Once ready, create a PR on GitHub. The PR will need to have all comments resolved and all tests passing before it will be merged.
- The PR should have a helpful description of the scope of changes being contributed.
- Include screenshots or video to reflect UX or UI updates
- Indicate if new settings need to be applied when the changes are merged - locally or in other environments