Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 5.72 KB

CONTRIBUTING.md

File metadata and controls

94 lines (70 loc) · 5.72 KB
Raw

Contributing to UIS

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the sections below for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

Note

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Donate in any way convenient for you
  • Mention the project at local meetups and tell your friends/colleagues

Code of Conduct

This project and everyone participating in it is governed by the UIS Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

I have a question

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue
  • Provide as much context as you can about what you're running into
  • Provide project and platform versions (unity, android, ios, webgl, etc), depending on what seems relevant

We will then take care of the issue as soon as possible.

Types of Contributions

Thanks for taking the time to contribute, once again! Please check out the options for how you can start contributing.

Important

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible:

  • Make sure that you are using the latest version
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Unity version
    • Platform target (Android, iOS, WebGL)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for UIS, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

  • Make sure that you are using the latest version
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one
  • Enhancement suggestions are tracked as GitHub issues
  • Create new issue
  • Use a clear and descriptive title for the issue to identify the suggestion
  • Provide a step-by-step description of the suggested enhancement in as many details as possible
  • Explain why this enhancement would be useful to most UIS users. You may also want to point out the other projects that solved it better and which could serve as inspiration

Implementing Features

Look through the GitHub issues for features. Anything tagged with "enhancement" is open to whoever wants to implement it.

Ready to contribute? Here are the simple steps for local development:

  1. Fork UIS repo on GitHub
  2. Clone your fork locally: 
    git clone [email protected]:YOUR_USERNAME/uis.git
  3. Make sure you have the minimum 2020.3.x version of Unity installed
  4. Create a branch for local development: 
    git checkout -b uis-bugfix-or-feature
  5. Implement what you wanted. Please make sure you add comments and stick to the existing code style
  6. Use .editorconfig file to format and check warnings
  7. Make sure there are no errors or warnings after assembly
  8. Please, follow the Conventional Commits, when you make a commit
  9. Commit your changes and push your branch to GitHub: 
    git add .
git commit -m "feat(editor): Add background change"
git push origin uis-bugfix-or-feature
  10. Submit a pull request through the GitHub website

See documentation for more details.