Before you begin:
- This project is powered by Unity. Make sure you're on the version of Unity that I currently support:
2019.3.1f1
- Have you read the code of conduct?
- Check out the existing issues & see if we accept contributions for your type of issue.
Before you make your changes, check to see if an issue exists already for the change you want to make.
If you spot something new, open an issue using a template. I'll use the issue to have a conversation about the problem you want to fix.
Fork using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
Fork using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
Make your changes to the file(s) you'd like to update.
When you're done making changes and you'd like to propose them for review, and open your PR (pull request).
- Once you submit your PR, I will review it with you. The first thing you're going to want to do is a self review.
- After that, I may have questions, check back on your PR to keep up with the conversation.
- Did you have an issue, like a merge conflict? Check out the git tutorial on how to resolve merge conflicts and other issues.
Congratulations! And thank you for contributing to an open-source VR application. You are a hero! ✨
Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.
Plus, you will get to enjoy watching your contributions become live as they are pushed to Steam!
Now that you're a part of the LuxVR community, you can keep participating in many ways.
Learn more about contributing:
You can contribute to LuxVR content in several ways. This repository is the place to discuss and collaborate!
Issues are used to track tasks that contributors can help with.
If you've found something in the content or the application that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a template. I'll use the issue to have a conversation about the problem you want to fix.
If you'd like to
- help others,
- port to different operating systems,
- share HMD test results,
- troubleshoot,
- share a great idea,
this is where you can do it!
Check out the issue labels and templates.
Github Discussions is currently in beta. I plan on transferring non-code related 'issues' to discussions.
A pull request is a way to suggest changes in our repository.
When I merge those changes, they should be deployed to Steam. To learn more about opening a pull request in this repo, see Opening a pull request below.
As an indie VR/AR developer, I'll be doing my best to answer your questions and solve your problems regarding LuxVR. But I prefer to provide this support through the available channels of this repository, not via private messaging or e-mails.
You can browse existing issues to find something that needs help!
Labels can help you find an issue you'd like to help with.
help
label: To ask for help about the use of LuxVR. Any general question goes here.bug
label: To report those nasty bugs.hmd test
label: To share your test results with different HMDs.port
label: To help with porting to other operating systems.enhancement
label: To suggest new features.
You can use the GitHub user interface ✏️ for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
I will personally review every single PR. Yes.
You should always review your own PR first before submitting.
I may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
As you update your PR and apply changes, mark each conversation as resolved.