Skip to content

Latest commit

 

History

History
106 lines (71 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

106 lines (71 loc) · 3.21 KB
Raw

Contributing to UnityMeshSimplifier

Thank you for considering contributing to this project.

Setup

In order to start contributing to this project, you will need to setup a new Unity project. Make sure that you are using a compatible version of Unity (see here).

The next step is to fork your own copy of this repository here on Github. Once you have your forked copy, you can should now clone it into the Packages directory of your Unity project.

Your Unity project structure should now look something like this:

Assets
Library
  ...
Packages
  UnityMeshSimplifier
    ...
ProjectSettings
  ...

When starting up your Unity project, you should see UnityMeshSimplifier appear in the package manager (Window -> Package Manager).

Commit Guidelines

We have strict rules over how our git commit messages can be formatted. This is due to them being used for automated semantic releases, as well as making the messages more readable and standarized.

Each commit should only ever do one change, so that it is easy to review.

Commit Message Format

Every commit must specify at least a type and a subject. While scope, body, and footer remains optional.

<type>(scope): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer than 100 characters (with the header being maximum 72 characters), in order for them to be easy to read in varios git tools.

Examples:

fix(editor): lod generator component editor exception when generating lods

Fixed a bug with exceptions sometimes being thrown when clicking on the button
to generate LODs in the LODGeneratorHelper editor.

docs(readme): added more detailed examples to the readme

Type

All supported commit types:

  • chore: Changes that aren't relevant to a release.
  • ci: Changes made to the CI configuration files and scripts.
  • docs: Changes to documentation.
  • feat: A new feature.
  • fix: A bug fix.
  • perf: Performance optimization.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • style: Changes that do not effect the logic of the code.
  • test: Added or modified tests

Scope

A few recommended scopes:

  • component
  • editor
  • lod
  • math
  • mesh
  • utility

Please note that you are also free to use additional scopes, but only if necessary.

Subject

The subject of a commit should be short and be effective in explaining it.

Body

A body can be used if the subject cannot accurately explain everything that the commit contains.

Have in mind however, that each commit should only contain one change.

Footer

A footer can be used to specify issues that can be resolved/closed.

Read more about how that works here.

Submitting changes

Please send me a pull request with a short and clear title and a clear description that effectively conveys what your goal of the changes are. Please also mention any issues that your pull request aims to solve.