Skip to content

Contributing

Eric Slutz edited this page Jun 11, 2026 · 1 revision

Contributing

Blockiverse VR is source-available / All Rights Reserved. Contributions should preserve the project constraints, canonical rulesets, Quest comfort target, and original identity.

Before You Start

Design and Implementation Standards

  • Use stable canonical IDs and display names from the rulesets.
  • Treat old temporary validation names as migration inputs only.
  • Keep pure gameplay/data systems testable without VR hardware where practical.
  • Preserve host-authoritative multiplayer commands.
  • Preserve Quest comfort defaults and readable VR UI.
  • Use original art, audio, names, and UI. Do not copy protected third-party identity.
  • Update docs and CHANGELOG.md when behavior, workflow, architecture, release process, or user-visible scope changes.

Pull Request Expectations

A strong PR includes:

  • Clear summary of player-facing and technical changes.
  • Linked issue when one exists, or the relevant execution-plan/ruleset section.
  • Validation commands and result summary.
  • Manual Quest validation for VR, save/load, networking, performance, signing, store, or device behavior changes.
  • Residual risk and follow-ups.

Recommended validation anchors:

bash -n scripts/ci/forbidden-files.sh scripts/unity/*.sh
scripts/ci/forbidden-files.sh
scripts/unity/run-tests.sh

For Unity-impacting work, also run a development APK build when practical:

scripts/unity/build-development-apk.sh /tmp/blockiverse-vr-development.apk

Issues and Discussions

Use issues for actionable work: bugs, blockers, scoped features, validation-gated tasks, and durable follow-ups.

Use discussions for announcements, Q&A, troubleshooting, ideas, gameplay/build feedback, Quest setup help, and community reports that are not ready to become issues.

Clone this wiki locally