diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 00000000..a0870d56 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,8 @@ +# PR review process + +- Any PR must have an entry in the corresponding changelog in a separate commit (CHANGELOG.MD file) +- Changelog follow these guidelines: https://github.com/Unity-Technologies/PostProcessing/blob/v2/CHANGELOG.md +- Each release branch (2018.1, 2018.2...) have a unique Changelog file +- when backporting, don't backport the changelog commit but update the branch changelog manually +- (optional) add reviewver from doc team +- Any more complex description of a change with future need to go in a release note file \ No newline at end of file diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md new file mode 100644 index 00000000..720ba4b8 --- /dev/null +++ b/CONTRIBUTIONS.md @@ -0,0 +1,9 @@ +# Contributions + +## If you are interested in contributing, here are some ground rules: +* Talk to us before doing the work -- we love contributions, but we might already be working on the same thing, or we might have different opinions on how it should be implemented. + +## All contributions are subject to the [Unity Contribution Agreement(UCA)](https://unity3d.com/legal/licenses/Unity_Contribution_Agreement) +By making a pull request, you are confirming agreement to the terms and conditions of the UCA, including that your Contributions are your original creation and that you have complete right and authority to make your Contributions. + +## Once you have a change ready following these ground rules. Simply make a pull request in Github \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..f6cecd2d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,5 @@ +Copyright © 2018 Unity Technologies ApS + +Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License). + +Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions. \ No newline at end of file diff --git a/README.md b/README.md index e69de29b..332cf0fa 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,6 @@ +XRAutomatedTests is where you can find functional, performance, and other types of automated tests for your XR Unity development. All tests are written in the [Unity Test Runner](https://docs.unity3d.com/Manual/testing-editortestsrunner.html) framework; please see the Unity documentation for more information about how to run tests with the [Unity Test Runner](https://docs.unity3d.com/Manual/testing-editortestsrunner.html). Where appropriate, specific execution examples are provided for the various tests. + +See links below or in the navigation bar to the right to get started: + +1. [Performance Tests](https://github.com/Unity-Technologies/XRAutomatedTests/wiki/Performance-Tests) +2. Functional Tests (coming soon) \ No newline at end of file