Skip to content
This repository has been archived by the owner on Mar 24, 2022. It is now read-only.

Latest commit

 

History

History
89 lines (76 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

89 lines (76 loc) · 3.33 KB
Raw

How to Contribute

Thank you for considering to contributing. We welcome everyone to improve the quality and add content to this repository.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to lewisjohnsondev@gmail.com.

The following is a set of guidelines for contributing to Unity User Interface Examples. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table of contents

Getting Started

Before you can contribute, you'll need a GitHub account. If you're a developer you'll need Unity 2017.1. Most projects come with a Visual Studio project solution, if you're on Windows, we recommend using it.

Quick Notes

  • We only accept examples written in C#.
  • Feel free to add to the .gitignore file.
  • There should be no spaces in any directory name.
  • We don't take requests for new examples.
  • When changing code, don't forget the Code Style Guidelines

Reporting a Bug

  • Submit an issue, assuming one does not already exist.
  • Clearly describe the issue including steps to reproduce.

Improving an Example

Sometimes an example will have unclean code, a bug, or missing documentation. We welcome you to fix any example you see needs improving.

  • Follow the "Reporting a bug" steps.
  • Assign yourself to the issue.
  • Fork the repository.
  • Add your improvements.
  • Submit a new pull request.
    • The title should be "Improved {Example Name} example", followed by a detailed expanded description.
  • Wait for it to be approved.

Adding a New Example

Follow quick start or manual way.

Quick Start

There is a little python script called create-files.py in the root folder to help kickstart new examples. Just run the script and follow the prompts then you're good to go!

  • Fork the repository.
  • Run create-files.py.
  • Submit a new pull request.
  • Wait for it to be approved.

Manual

  • Fork the repository.
  • Add the examples code and scene, make sure you follow the same structure as existing examples.
unity-ui-examples
│   README.md    
└───Assets
   └───Common
   └───ScreenSpace
   │	└───ExampleProjectName
   │		│   README.md
   │		└───Scenes
   │			│   ExampleProjectName.unity
   │		└───Scripts
   │			│   ExampleScript.cs
   │			│   ExampleScript2.cs
   │		└───Images
   │			│   Background.png
   │		└───Etc
   │			│   etc.x
   └───WorldSpace
   	└───ExampleProjectName
   		│   README.md
   		└───Scenes
   			│   ExampleProjectName.unity
   		└───Scripts
   			│   ExampleScript.cs
   			│   ExampleScript2.cs
   		└───Images
   			│   Background.png
   		└───Etc
   			│   etc.x
  • Add a README.md which follows the documention guideline.
  • Submit a new pull request.
  • Wait for it to be approved.