Skip to content

Commit 399c7b3

Browse files
mattwalsh-unitymattwalsh-unity
authored
docs: cleaned up readme, 3rd party license, etc. (#524)
* chore: update package manifest version to 0.1.0 MTT-488 * chore: cleaned up readme, 3rd party license, etc. * more third_party * making copies in root dir
1 parent d0b9dfc commit 399c7b3

File tree

9 files changed

+245
-18
lines changed

9 files changed

+245
-18
lines changed

‎LICENSE.md‎

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
MIT License
22

3-
Copyright (c) 2018, 2019 Albin Corén
3+
Copyright (c) 2021 Unity Technologies
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
116

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
148

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Sysroots
2+
Contains the repos for both the MLAPI SDK and the UTP transport library
3+
4+
Contents:
5+
* com.unity.multiplayer.mlapi -- the MLAPI SDK
6+
* com.unity.multiplayer.transport.utp -- the MLAPI wrapper for the UTP transport library

‎com.unity.multiplayer.mlapi/CODE_OF_CONDUCT.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, and will communicate reasons
43+
for moderation decisions when appropriate.
44+
45+
## Scope
46+
47+
This Code of Conduct applies within all project spaces, and it also applies when
48+
an individual is representing the project or its community in public spaces.
49+
Examples of representing a project or community include using an official
50+
project e-mail address, posting via an official social media account, or acting
51+
as an appointed representative at an online or offline event.
52+
53+
## Enforcement
54+
55+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
56+
reported by contacting the project team. All
57+
complaints will be reviewed and investigated and will result in a response that
58+
is deemed necessary and appropriate to the circumstances. The project team is
59+
obligated to maintain confidentiality with regard to the reporter of an incident.
60+
Further details of specific enforcement policies may be posted separately.
61+
62+
Project maintainers who do not follow or enforce the Code of Conduct in good
63+
faith may face temporary or permanent repercussions as determined by other
64+
members of the project's leadership.
65+
66+
## Attribution
67+
68+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
69+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

‎com.unity.multiplayer.mlapi/CODE_OF_CONDUCT.md.meta‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎com.unity.multiplayer.mlapi/CONTRIBUTING.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to Unity Multiplayer Networking!
4+
5+
Here are our guidlines for contributing:
6+
7+
* [Code of Conduct](#coc)
8+
* [Ways to Contribute](#ways)
9+
* [Issues and Bugs](#issue)
10+
* [Feature Requests](#feature)
11+
* [Improving Documentation](#docs)
12+
* [Unity Contribution Agreement](#cla)
13+
* [Pull Request Submission Guidlines](#submit-pr)
14+
15+
## <a name="coc"></a> Code of Conduct
16+
17+
Please help us keep MLAPI open and inclusive. Read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
18+
19+
## <a name="ways"></a> Ways to Contribute
20+
21+
There are many ways in which you can contribute to the MLAPI.
22+
23+
### <a name="issue"></a> Issues and Bugs
24+
25+
If you find a bug in the source code, you can help us by submitting an issue to our
26+
GitHub Repository. Even better, you can submit a Pull Request with a fix.
27+
28+
### <a name="feature"></a> Feature Requests
29+
30+
You can request a new feature by submitting an issue to our GitHub Repository.
31+
32+
If you would like to implement a new feature then consider what kind of change it is:
33+
34+
* **Major Changes** that you wish to contribute to the project should be discussed first with other developers. We will have a more formal process for this soon. For now submit your ideas as an issue.
35+
36+
* **Small Changes** can be directly submitted to the GitHub Repository
37+
as a Pull Request. See the section about [Pull Request Submission Guidelines](#submit-pr).
38+
39+
### <a name="docs"></a> Documentation
40+
41+
We accept changes and improvements to our documentation. Just submit a Pull Request with your proposed changes as described in the [Pull Request Submission Guidelines](#submit-pr).
42+
43+
## <a name="cla"></a> Contributor License Agreements
44+
45+
When you open a pull request, you will be asked to enter into Unity's License Agreement which is based on The Apache Software Foundation's contribution agreement. We allow both individual contributions and contributions made on behalf of companies. We use an open source tool called CLA assistant. If you have any questions on our CLA, please submit an issue
46+
47+
## <a name="submit-pr"></a> Pull Request Submission Guidelines
48+
49+
We use the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the development of MLAPI. This means development happens on the **develop branch** and Pull Requests should be submited to it.
50+
51+
### Commit Message Guidelines
52+
We have very precise rules over how our git commit messages can be formatted. This leads to **more
53+
readable messages** that are easy to follow when looking through the **project history**. We follow angular's message format.
54+
55+
#### **Commit Message Format**
56+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
57+
format that includes a **type**, a **scope** and a **subject**:
58+
59+
```
60+
<type>(<scope>): <subject>
61+
<BLANK LINE>
62+
<body>
63+
<BLANK LINE>
64+
<footer>
65+
```
66+
67+
The **header** is mandatory and the **scope** of the header is optional.
68+
69+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
70+
to read on GitHub as well as in various git tools.
71+
72+
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
73+
74+
If the change isn't backwards compatible. You have to disclose that in the footer like this. Here is an example:
75+
```
76+
perf(networked-vars): Improved performance by removing duplex functionality
77+
78+
BREAKING CHANGE: Removes duplex functionality from networked vars in order to improve performance
79+
```
80+
Samples:
81+
82+
```
83+
docs(changelog): update changelog to beta.5
84+
```
85+
```
86+
fix(release): need to depend on latest rxjs and zone.js
87+
88+
The version in our package.json gets copied to the one we publish, and users need the latest of these.
89+
```
90+
91+
### Revert
92+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
93+
94+
### Type
95+
Must be one of the following:
96+
97+
* **build**: Changes that affect the build system or external dependencies (example scopes: msbuild, xUnit)
98+
* **ci**: Changes to our CI configuration files and scripts (example scopes: AppVeyor, xUnit)
99+
* **docs**: Documentation only changes
100+
* **feat**: A new feature
101+
* **fix**: A bug fix
102+
* **perf**: A code change that improves performance
103+
* **refactor**: A code change that neither fixes a bug nor adds a feature
104+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
105+
* **test**: Adding missing tests or correcting existing tests
106+
107+
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
108+
109+
$ git commit -m "A brief summary of the commit
110+
>
111+
> A paragraph describing what changed and its impact."

‎com.unity.multiplayer.mlapi/CONTRIBUTING.md.meta‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎com.unity.multiplayer.mlapi/LICENSE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
MIT License
22

3-
Copyright (c) 2020 Unity Technologies
3+
Copyright (c) 2021 Unity Technologies
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

77
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
88

9-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎com.unity.multiplayer.mlapi/Third Party Notices.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
This package contains third-party software components governed by the license(s) indicated below:
2+
---------
3+
4+
## Package: Editor/CodeGen/XXHash
5+
6+
---------
7+
8+
Component Name: xxHash
9+
10+
License Type: MIT
11+
12+
Copyright (c) 2015, 2016 Sedat Kapanoglu
13+
14+
http://www.xxhash.com/
15+
16+
Permission is hereby granted, free of charge, to any person obtaining a copy
17+
of this software and associated documentation files (the "Software"), to deal
18+
in the Software without restriction, including without limitation the rights
19+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
20+
copies of the Software, and to permit persons to whom the Software is
21+
furnished to do so, subject to the following conditions:
22+
23+
The above copyright notice and this permission notice shall be included in all
24+
copies or substantial portions of the Software.
25+
26+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
29+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
30+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
31+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32+
SOFTWARE.

‎com.unity.multiplayer.mlapi/Third Party Notices.md.meta‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)