Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
72 lines (49 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
72 lines (49 loc) · 1.46 KB

Contributing to Vertigo Sync

Thanks for contributing.

Please follow CODE_OF_CONDUCT.md in all project spaces.

Development Prerequisites

  • Rust (stable)
  • Roblox Studio (latest)
  • aftman for optional Roblox-side tooling
  • Tools from aftman.toml when working on Roblox-side fixtures (stylua, selene)

Install local tools:

cargo build
aftman install

Local Workflow

  1. Start the sync server from this checkout:
cargo run -- serve
  1. Install the Studio plugin:
cargo run -- plugin-install

  1. Restart Studio and use the Vertigo Sync plugin.

  2. Save source files and verify they sync into Explorer.

Code Quality

Run checks before opening a PR:

cargo test --all-targets --all-features

If you touch Roblox-side Lua or shell scripts, also run:

stylua --check .
selene .
bash -n scripts/*.sh

Pull Request Expectations

  • Keep changes scoped and focused.
  • Include a short test plan in the PR description.
  • Include before/after screenshots or videos for UI/feel changes.
  • Do not commit secrets, API keys, or personal account IDs.
  • Respect the root LICENSE.
  • Keep generated plugin artifacts and their source in sync when a change affects plugin packaging.

Reporting Bugs

When filing issues, include:

  • OS and Roblox Studio version
  • cargo --version
  • Repro steps
  • Expected vs actual behavior
  • Relevant vsync logs or Studio Output lines