Community

Contribute

Build

Clone the repository.

For C# project, proceed to the Heimdall folder and build the solution with your preferred .NET tool.

For C++ project, proceed to the Heimdall.CppListener folder and use CMake to build.

Testing

Unit tests are implemented in all projects whose name match the pattern *.Tests.

For C++, integration tests are used, with the C# Heimdall.Bifrost.Tests project running the C++ TestApp.

For C#, MSTest is used. They can be ran with your preferred .NET tool.

To add new tests, add them to the relevant test project. If the test project does not exist then create one with the name of the project to test, suffixed with .Tests.

Pull Request

Changes ready for release should be merged into the main branch via a pull request. Please follow the below practices when applicable:

  • If the change is a bug fix, consider adding a regression unit test.

  • Resolve any newly generated warnings.

  • Revise the documentation as necessary.

  • Add unit or integration tests to validate new features or prevent bug regressions.

Once your pull request is checked in to main, a deployment pipeline will automatically run and publish new release packages.

Support

For additional help and support, first-party and limited integration studios can post directly on our Teams channel. If you do not have access to our Teams, please reach out to SQ Tech via the communications channel set up by your third-party publishing team, or else forward your question to our support email mailto:sqtechsupport@microsoft.com.