Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.82 KB

Magic Layout Contributing Guide

I am really excited that you are interested in contributing to Magic Layout ❤️. Magic Layout is still in development, Our goal is to make working with unity editor fun and more productive.

Issue reporting guidelines

Please search for similar issues before opening an issue and always follow the issue templates. Please provide a detailed description of the problem in your PR and live demo or screenshots are preferred.

Pull request guidelines

Please make sure the following is done before submitting a PR:

  • Submit PRs directly to the develop branch.
  • Reference the related issue in the PR comment.
  • Please test your PR before submitting.

If you add new feature:

  • Open a feature issue first.
  • Provide convincing reason to add this feature.
  • Then submit your PR.

If fix a bug:

  • If you are resolving a special issue, please add fix: #<issue number> <short message> in your PR title.
  • Provide detailed description of the bug in your PR and/or link to the issue. You can also include screenshots.

Other ways to help:

  • Translation
  • Help to test Magic Layout.
  • Help to answer issues or discuss changes and features.

Quick start

  1. Fork the repository.
  2. Clone your fork: git clone git@github.com:<username>/unity-magic-layout.git
  3. Create a feature branch: git checkout -b feature
  4. Make you changes and push your branch.
  5. Create a PR against develop and describe your changes.

Style guide

Please follow Microsoft C# Coding Conventions.