Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 2.1 KB
Raw

Contributing

Thank you for your interest in contributing to the Multiplayer Community Contributions repository.

Here are our guidlines for contributing:

Code of Conduct

Please help us keep Unity Multiplayer Networking open and inclusive. Read and follow our Code of Conduct.

Ways to Contribute

Issues and Bugs

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository.

New Content and Features

If you would like to add new content to the contributions repository or improve existing content create a Pull Request.

Creating a new Netcode for GameObjects Transport

  • Clone the multiplayer-community-contributions repository
  • Copy the com.community.netcode.transport.template folder
  • Rename the folder to better reflect your transport's name.
  • Update CHANGELOG.md, package.json, README.md with information about your transport
  • Rename TemplateTransport.cs and implement your transport. Rename the .asmdef file to the name of your transport as well.
  • If your transport needs any additional user actions to run please specific them in README.md

Adding an extension to the com.community.netcode.extensions package

  • Create a new folder in the extension's package runtime folder.
  • Add your code to the folder.
  • Put a short README.md into the folder explaining what your extension does and how to use it.

Contributor License Agreements

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