docs: Add a comment in shorebird.yaml to check in to version control. (…

…#372)
shorebirdtech · Apr 26, 2023 · d11c77f · d11c77f
1 parent 8538943
commit d11c77f
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/packages/shorebird_cli/lib/src/shorebird_config_mixin.dart b/packages/shorebird_cli/lib/src/shorebird_config_mixin.dart
@@ -54,11 +54,12 @@ mixin ShorebirdConfigMixin on ShorebirdCommand {
     File(
       p.join(Directory.current.path, 'shorebird.yaml'),
     ).writeAsStringSync('''
-# This file is used to configure the Shorebird CLI.
+# This file is used to configure the Shorebird updater used by your application.
 # Learn more at https://shorebird.dev
+# This file should be checked into version control.
 
 # This is the unique identifier assigned to your app.
-# It is used by your app to request the correct patches from the Shorebird servers.
+# It is used by your app to request the correct patches from Shorebird servers.
 app_id: $appId
 ''');