Skip to content
This repository has been archived by the owner on Jun 10, 2022. It is now read-only.

Latest commit

 

History

History
80 lines (57 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

80 lines (57 loc) · 3.44 KB
Raw

Mixed Reality Extension Unity Contribution Guide

Want to help out? Great! Here are a couple of ways to help:

Build a cool MRE with the SDK itself

Clone the samples and start making your own MRE. Try to deploy it and tell us how it went.

Integrate the MRE Unity DLL into your own Unity3D project

The MRETestbed Unity3D project is a simple implementation. Look at that to see how you can implement the SDK into your own project. Run through the functional test MRE to see if everything works. For more info, please see INTEGRATING.md.

Implement features in the MRE SDK and the Unity DLL

New features often require both a SDK side and Unity side set of changes. We usually implement both sides simultaneously, and add at least one functional test to verify the functionality. We highly recommend reaching out to the MRE SDK discord community to discuss any architecture before implementing, as we are always stronger together.

Write your own MRE Client library for another 3D engine

Great idea. That's quite a bit more work than dropping a DLL into a Unity3D project, but it is definitely doable! Please reach out to the MRE maintainers, so we can make sure your client library keeps up to date with future Unity client changes.

Give Feedback

Submit bugs and feature requests on the issues page and help us verify fixes.

Contribute Code

Submit pull requests for unity repository and/or sdk repository for bug fixes and features. Please mark if they are interdependent.

Where to start

Not sure what to implement? There are a number of issues labeled Help Wanted in the sdk repository that could all be good starting points.

Other areas could be to create additional functional tests and samples, and to comment on the documentation.

Tips to create good pull requests

Before accepting pull requests, we run all functional tests within the host app.

  • Clear description
  • Single issue per pull request
  • Note if it there is a matching pull request in the sdk repository

Coding guidelines

  • If using Visual Studio 2017, use the auto-formatter
  • add copyright header to new files

Legal

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.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., label, 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.