Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.79 KB

Contributing to BDK

Firstly, thank you so much for wanting to help out! If you need a place to start, have a look if there are any open issues or open your own with bugs or feature requests. We are happy to take any improvements, both big and small.

Development Environment

There are many ways to set up your environment to your liking, but if you don't know where to start, here is what we suggest:

  1. Install the required versions of Unity, Visual Studio, and the Windows SDK
  2. Clone this repo locally
  3. Create a new Unity 3D project and set up your project settings
  4. Add BDK to your project using the package manager, but add the project from disk instead of from git
  5. (Optional) Install BDK Essentials to your project.

Now you can have fun playing around. You can change whatever you want in your Unity project, since only changes to the package will be added to the repo.

Building and testing

We have a short Build guide on the wiki.

Submitting a Pull Request

To start contributing, fork this repository, create a branch and code away. Then submit a pull request and we'll have a look!

Getting Help

We're still iin the early stages of the project and don't have much of a community yet. If you are contributing feel free to contact us and have a chat. We're happy to help with any issues or just to chat 😄.