-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing Guide
WORK IN PROGRESS If you have any doubt, please make sure to contact me.
If you find an issue you want to help with, first check that no one is already assigned. If it's not, leave a comment indicating that you want to work on it and after having a small conversation and resolving any doubts you might have, I will assign that issue to you so you can start working on it.
Before starting to work on an issue or some other alteration, you must first fork the project. This will create a project on your profile that's a fork of Cardboard. There you can modify and do whatever you want with it.
Before working on anything, make sure you update your fork to be synced with the Cardboard repo. This way you will always work with the latest changes.
I recommend that for each, issue / bug / feature / etc... you create a new branch and work on that branch. If you're already proficient using git and so on, feel free to work as you do :) Otherwise, try to follow the guide.
If you add a new feature or fix a bug, remember to add pertinent tests. If you don't know how or don't want to write them, let me know in the PR and I will add them myself. But I would love it if you could add them yourself!
When you have something done, you must raise a PR in the Cardboard repository. Make sure to add a good explanation of what you've done. I will review the PR, and mention any issues with it. Once everything is resolved, I will merge the PR.
This Wiki is a work in progress, and your help is greatly appreciated!
If you have some free time and are interested in contributing to the wiki or the project in general, please don't hesitate to reach out. All contributions are welcome!