Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (29 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 2.66 KB

Contributing to ComfyUI-VRChat-Assets

First off, thank you for considering contributing to ComfyUI-VRChat-Assets! It's people like you that make this such a great tool for the community.

This document provides guidelines for contributing to this project. Please feel free to propose changes to this document in a pull request.

How Can I Contribute?

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into ComfyUI-VRChat-Assets itself.

Reporting Bugs

This project uses GitHub Issues to track bug reports. Please fill out the bug report template when creating a new issue.

Before creating a bug report, please check that the issue has not already been reported.

Suggesting Enhancements

This project uses GitHub Issues to track feature requests. Please fill out the feature request template when creating a new issue.

Pull Requests

We welcome pull requests for bug fixes and new features. Please ensure your pull request follows these guidelines:

  1. Fork the repository and create your branch from main.
  2. Add tests for any new code you write.
  3. Ensure all tests pass before submitting your pull request.
  4. Add an entry to the CHANGELOG if your changes are significant.
  5. Follow the existing code style.
  6. Write a clear and concise pull request description.

Development Setup

To get started with development, you'll need to set up a VRChat world project. The recommended way to do this is by using the VRChat Creator Companion (VCC).

  1. Install VRChat Creator Companion: Download and install the VCC from the official VRChat website.
  2. Create a New Project: Use the VCC to create a new VRChat World project. This will ensure you have the correct Unity version and all the necessary VRChat SDKs.
  3. Install UdonSharp: In the VCC, manage your new project and add the "UdonSharp" package from the Community Packages.
  4. Clone the Repository: Clone this repository to your local machine.
  5. Add to your Project: You can either import the .unitypackage or copy the Image Display, Video Display, Scripts, and Materials folders into the Assets directory of your VCC project. For active development, copying the folders is recommended.

Code of Conduct

We have a Code of Conduct that we expect all contributors to adhere to. Please read it before contributing.

Questions?

If you have any questions, feel free to join our Discord community.