Permalink
Fetching contributors…
Cannot retrieve contributors at this time
52 lines (31 sloc) 3.73 KB

Contributing Guidelines

Issues, pull requests, and other contributions are welcomed!

A few tips:

Is OSVR-Unity the right repository?

The OSVR system consists of a number of repositories, many of which are in the OSVR organization on GitHub.

The OSVR-Unity repo contains the code that integrates OSVR, via the Managed-OSVR bindings (for using OSVR ClientKit from .NET-based languages), with the Unity game engine, as well as some sample code.

  • If you've got an issue to report, a bug fix, or a feature addition specific to the OSVR-Unity integration components: yes, you're in the right spot! (If you aren't sure if it's Unity-specific or in Managed-OSVR, it's fine to start here.)
  • If you're got something that's related to .NET but not Unity-specific: you're close - see the Managed-OSVR repo for the non-Unity-specific OSVR .NET bindings.
  • If you have an issue, bug fix, or other contribution related to the OSVR server (which comes bundled with an OSVR-Unity binary snapshot) or one of the plugins: you're close - see the OSVR-Core repo for the server and its bundled plugins.
  • If you have a hardware or software issue related to OSVR but aren't sure exactly where it fits: let us know with a support ticket at http://support.osvr.com

Getting ready

General "getting started" instructions can be found at http://osvr.github.io.

When making pull requests, please fork the project and create a topic branch off of the master branch. (This is what GitHub does by default if you start editing with your web browser.)

When developing, make small commits that are nevertheless "whole": small enough to review, but each containing a logical single change in its entirety. (If you don't understand what we mean by this, that's OK, we'll work it out.)

It's OK to rebase your topic branch to make the history more clear. Avoid merging from master into your topic branch: if you need a change from master, rebase; otherwise, try to keep topic branches short-lived enough that we can get your code in to the mainline before much else changes!

Try to develop code that is portable (not particularly tied to a single operating system/compiler/etc) - OSVR runs on a number of platforms, and while we don't expect you to have all of them to test on, it's good to keep in mind.

Please note the compatible versions of Unity in the project README, and make sure that any change is either optional (and properly version-guarded) or works all the way back to the oldest version of Unity we support.

If you're adding something reasonably testable, please also add a test. If you're touching code that already has tests, make sure they didn't break.

Please follow general "idiomatic practices" with regards to code style. The main points are to match code surrounding what you're edited. These help ensure that your changes are not artificially large because of whitespace, etc, that it's easy to review your changes, and that your code will be maintainable in the future.

Keep in mind that some changes have the potential to impact (that is, break) a lot of downstream code (other integrations, games), so changes that affect how a developer would write code using these bindings will be more rigorously reviewed and discussed. We'd recommend opening an issue for discussion before you start work on any such changes, to make sure we'll be able to accept your contribution.

License

No formal copyright assignment is required. If you're adding a new file, make sure it has the appropriate license header. Any contributions intentionally sent to a project are considered to be offered under the license of the project they're sent to.