Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 2.25 KB
Raw

Contributing to Visual State Machine V2

First off, thank you for considering contributing to Visual State Machine V2. Any contributions you make are greatly appreciated.

How to Contribute

There are many ways you can contribute to our project:

  • Submitting bug reports and feature requests
  • Writing tutorials or blog posts
  • Improving the documentation
  • Writing code which can be incorporated into Visual State Machine V2 itself

Reporting Bugs

Bugs are tracked as GitHub issues. To report a bug, create an issue and use our bug report template to provide all the necessary information.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Visual State Machine V2, including completely new features and minor improvements to existing functionality. Use our feature request template to submit a feature request.

Pull Requests

Here's how you can make a pull request (PR) to the project:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure your code adheres to the existing style to maintain the project's consistency.
  4. Issue that pull request!

Coding Guidelines

Visual State Machine V2 follows the Microsoft C# Coding Conventions. Please ensure your code contributions adhere to these standards.

Local Development

As this project is a Unity Package I find the best way to develop it is to create a new Unity project and add the package as a local package. This allows you to test the package in a real Unity environment. My personal preference is to clone the repo and simlink the package into the Unity project's Packages folder. This allows me to easily make changes to the package and test them in the Unity project.

Community and Behavioral Expectations

Respect our code of conduct, be kind to each other, and help out with the project. We want a healthy and welcoming community.

License

By contributing to Visual State Machine V2, you agree that your contributions will be licensed under MIT.

Questions?

If you have any questions, please feel free to contact paul@nonatomic.co.uk

Thank you for contributing to Visual State Machine V2.