Legacy Documentation: Version 4.6
Language: English
Further Reading
Platform Specific

FAQ

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Here we’ve compiled some frequently asked questions.

Q: Why BitBucket instead of GitHub or self-hosted?

A: At Unity, we are fans of both BitBucket and GitHub. We also self-host and use a 3rd-party hosting solution called Kallithea internally. Ultimately, we chose BitBucket for our open-source components because:

  1. It allows us to let someone else worry about hosting (which lets us focus on what we’re good at)
  2. It supports both Mercurial and Git instead of only Git (we are heavy users of Mercurial internally, but also have some Git-based forks of open-source tools we use, so being able to store everything in one place made sense)

Q: What license are Unity’s Open-Source components released under?

A: Unity’s open-source components are generally released under an MIT/X11 license. Some projects, like Unity Test Tools, use 3rd-party components that are released under a different license. You can see the license information for each project by looking at the LICENSE file in the top-level of the source directory. Information about 3rd-party tools (if any) that are used in the project are described in an acknowlegements.markdown file.

Q: Will Unity accept patches? What about licensing?

A: We certainly will accept your patches! The type of patches we will accept depend on the project because different components are in different stages of development by the Unity devleopers. Bugfixes are great candidates for patches. As for new features or large refactorings, it will depend largely on the system in question. Check the documentation for the component you would like to modify for more information.

As mentioned previously, most of our components are licensed under an MIT/X11 license. You should be aware that we will only accept contributions that are also licensed under an MIT/X11 license. We will also assume the MIT/X11 license applies to the changes in your pull request unless otherwise stated.

Q: What coding standards does Unity use? How do I make sure my PR isn’t rejected due to bad formatting changes?

A: We’re working on getting documentation together for this ASAP. Watch this space! For now, just make sure to follow the formatting and conventions that already exist in the code you are modifying.

Further Reading
Platform Specific