Skip to content

UIEffect is an effect component for uGUI element in Unity. Let's decorate your UI with effects!

Notifications You must be signed in to change notification settings

SeungHuLee/UIEffect

 
 

Repository files navigation

(DEVELOP BRANCH)

NOTE: This branch is for development purposes only.
NOTE: To use a released package, see Releases page or default branch.




How to contribute this repository

See CONTRIBUTING.md and CODE_OF_CONDUCT.md.




How to develop

  1. Fork this repository.
  2. Clone the forked repository to local.
  3. Create your branch from develop branch.
  4. Develop the package.
  5. Commit with a message based on Conventional Commits.
  6. Fill out the description, link any related issues and submit your pull request.
    NOTE: Create a pull request to merge into develop branch

Committed messages in the most common cases

Case Commit message
Added a new feature feat: add new feature
Added a suggested feature #999 feat: add new feature
Close #999
Fixed a bug fix: a problem
Fixed a reported bug #999 fix: a problem
Close #999
Added features that include breaking changes feat: add new feature

BREAKING CHANGE: Details of the changes




How to release

NOTE: The contributor does not need to perform a release operation.

When you push to preview, master or v1.x branch, this package is automatically released by GitHub Action.
Internally, a npm tool semantic-release is used to release.

  • Update version in package.json
  • Update CHANGELOG.md
  • Commit documents and push
  • Update and tag upm branch
  • Release on GitHub
  • Publish npm registory

Alternatively, you can release it manually with the following command:

$ npm run release -- --no-ci

About

UIEffect is an effect component for uGUI element in Unity. Let's decorate your UI with effects!

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 60.7%
  • ShaderLab 31.4%
  • HLSL 7.9%