Skip to content

Latest commit

 

History

History
37 lines (19 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

37 lines (19 loc) · 2.19 KB

Contributing

If you have questions or ideas, feel free to open an issue, or join our Discord server.

If you'd like to contribute a change or new feature, please open an issue to discuss. We want to save you from doing work and making a pull request if it may not be accepted.

Bug fixes are welcome and don't need prior discussion or a Github issue.

Reporting Bugs

When submitting a bug report, please search for an existing or similar issue first.

If your problem seems unique, create a new issue! It's helpful to explain the problem you see, what you were expecting instead, and steps you took when the problem occurred. (actual behavior, expected behavior, steps to reproduce) Photos or video also help a lot!

Development

First create a new VRChat world project to use for development.

Fork the git repository and clone it into the Packages folder of your project. Rename the repository folder to "com.orchidseal.paradraw".

Create a new git branch for your changes. Development for ParaDraw happens on the main branch. So use it as the start point of your branch.

In Unity, create a scene to test your changes. Or, import the sample scene, found under the Samples tab in the package manager.

Make your changes and test them.

Commit to your git branch and push the changes to your forked repository.

Open a pull request in Github!

Samples

When changing samples, make sure the files are copied to the folder for that sample under Packages/com.orchidseal.paradraw/Samples~. If adding a sample, remember to add it to the package manifest (package.json).

Licensing

ParaDraw is licensed under the MIT License. By contributing, you agree to license your changes under the same license.