Unity package template📦

Fully automated version management and package publishing

What is it ?

Package template is a template repository to create quickly package for unity.

Unity package allow you to create independents features and include it like puzzle in your unity project to include its features.

This architecture is based on unity package layout presented here

I encourage you to create sample that can be imported independently thanks to unity package manager for more modularity. You can for example create demo, independent feature in your package theme... Sample folder contain character '~' that mean that this folder will be ignored by unity. All sample must be referenced in package.json.

Please don't change the license, and don't forget to update your changelog file and package version in package.json. For clear information about your package, make a demonstration, add description in GitHub and information in README.

How to create new package ?

Follow these step to create package based on this template:

1: Click on "Use this template" button to create a new repository based on this template.

2: In this step, we need add information about package that will be used to generate your package thanks to github action.

• Select the owner (by default you, if you want to create a package for this repository, please select OpenSourceUnityPackage). This repository name will be used to generate the package name.
• Then enter your project name. This name is very important because it will be used to generate the package name inside unity. For example TestPackageUnity will become open-source-unity-package.test-package-unity according to unity convention.
• Step 2, 3 and 4 are optional. You can add description, select public repository and include all branch (to include git flow).
• Now click on "select repository from template" to done this process

Well done ! Your package is now available. You can now develop it. Don't forgot to add complete description of it inside your README, unity and github to be community friendly ! May the opensource spirit guide your precious step ;D

Angular typo

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
  │                          elements|forms|http|language-service|localize|platform-browser|
  │                          platform-browser-dynamic|platform-server|router|service-worker|
  │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|ngcc|ve|
  │                          devtools
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

Type

Must be one of the following:

• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• ci: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• test: Adding missing tests or correcting existing tests

For example:

• feat: create new feature
• fix: fix an error
• docs: update readme

For more information see