From 10ff540c708cd45cd3f657073b6759b975c9e6ab Mon Sep 17 00:00:00 2001 From: usfbih8u <> Date: Mon, 24 Aug 2026 21:49:23 +0200 Subject: [PATCH] docs(runtime/help): add notes about using `VERSION` in `plugins.md` --- runtime/help/plugins.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/runtime/help/plugins.md b/runtime/help/plugins.md index 27d099973a..39619f9ea7 100644 --- a/runtime/help/plugins.md +++ b/runtime/help/plugins.md @@ -539,6 +539,8 @@ This file will contain the metadata for your plugin. Here is an example: Then open a pull request at the [official plugin channel](https://github.com/micro-editor/plugin-channel), adding a link to the raw `repo.json` that is in your plugin repository. -To make updating the plugin work, the first line of your plugin's lua code -should contain the version of the plugin. (Like this: `VERSION = "1.0.0"`) -Please make sure to use [semver](https://semver.org/) for versioning. +For plugin updates to work, your plugin's Lua code should include its version; +for example: `VERSION = "1.0.0"`. Note that `VERSION` is **not** declared as +`local`. By convention, this code is placed on the first line of your plugin's +main Lua file. Please make sure to use [semver](https://semver.org/) for +versioning. \ No newline at end of file