From 8461339e9a9d3b00fa37307acc7a503ba70a52b4 Mon Sep 17 00:00:00 2001 From: Blake Mealey Date: Sat, 20 Nov 2021 14:53:22 -0800 Subject: [PATCH] Add note for git submodules (#495) --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99abebfb..75fa762d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,11 @@ Sometimes there's something that Rojo doesn't do that it probably should. Please file issues and we'll try to help figure out what the best way forward is. +## Local Development Gotchas + +If your build fails with "Error: failed to open file `D:\code\rojo\plugin\modules\roact\src`" you need to update your Git submodules. +Run the command and try building again: `git submodule update --init --recursive`. + ## Pushing a Rojo Release The Rojo release process is pretty manual right now. If you need to do it, here's how: @@ -51,4 +56,4 @@ The Rojo release process is pretty manual right now. If you need to do it, here' * Update the leading text with a summary about the release * Paste the changelog notes (as-is!) from [`CHANGELOG.md`](CHANGELOG.md) * Write a small summary of each major feature - * Attach release artifacts from GitHub Actions for each platform \ No newline at end of file + * Attach release artifacts from GitHub Actions for each platform