From efa43aa8668a7441c1a3c4e7e20d9761c127a943 Mon Sep 17 00:00:00 2001 From: saygo-png Date: Sun, 28 Sep 2025 00:42:07 +0200 Subject: [PATCH] docs/contributing: change maintainers to a required field Signed-off-by: saygo-png --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e9da34e..159d274d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,6 +68,7 @@ A template plugin can be found in (plugins/TEMPLATE.nix)[https://github.com/nix- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | | **name** | The name of the plugin. | Yes | N/A | | **url** | The URL of the plugin's repository. | Yes | `package` parameter's `meta.homepage` | +| **maintainers** | Maintainers for the plugin. | Yes | N/A | | **callSetup** | Indicating whether to call the setup function. Useful when `setup` function needs customizations. | No | `true` | | **colorscheme** | The name of the colorscheme. | No | `name` parameter | | **configLocation** | The option location where the lua configuration should be installed. Nested option locations can be represented as a list. The location can also be wrapped using `lib.mkBefore`, `lib.mkAfter`, or `lib.mkOrder`. | No | `"extraConfigLuaPre"` if `isColorscheme` then `extraConfigLuaPre`, otherwise `"extraConfigLua"` | @@ -83,7 +84,6 @@ A template plugin can be found in (plugins/TEMPLATE.nix)[https://github.com/nix- | **imports** | Additional modules to import. | No | `[]` | | **isColorscheme** | Indicating whether the plugin is a colorscheme. | No | `false` | | **moduleName** | The Lua name for the plugin. | No | `name` parameter | -| **maintainers** | Maintainers for the plugin. | No | `[]` | | **optionsRenamedToSettings** | Options that have been renamed and move to the `settings` attribute. | No | `[]` | | **packPathName** | The name of the plugin directory in [packpath](https://neovim.io/doc/user/options.html#'packpath'), usually the plugin's github repo name. E.g. `"foo-bar.nvim"`. | No | `name` parameter | | **package** | The nixpkgs package attr for this plugin. Can be a string, a list of strings, a module option, or any derivation. For example, "foo-bar-nvim" for `pkgs.vimPlugins.foo-bar-nvim`, or `[ "hello" "world" ]` will be referenced as `pkgs.hello.world`. | No | `name` parameter | @@ -134,6 +134,7 @@ Such plugins are usually configured via vim globals, but often have no configura | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------- | | **name** | The name of the Vim plugin. | Yes | N/A | | **url** | The URL of the plugin repository. | Yes | `package` parameter's `meta.homepage` | +| **maintainers** | The maintainers of the plugin. | Yes | N/A | | **colorscheme** | The name of the colorscheme. | No | `name` parameter | | **dependencies** | A list of [`dependencies`] to enable by default with this plugin. (List of strings) | No | `[]` | | **deprecateExtraConfig** | Flag to deprecate extra configuration. | No | `false` | @@ -145,7 +146,6 @@ Such plugins are usually configured via vim globals, but often have no configura | **globalPrefix** | Global prefix for the settings. | No | `""` | | **imports** | A list of imports for the plugin. | No | `[]` | | **isColorscheme** | Flag to indicate if the plugin is a colorscheme. | No | `false` | -| **maintainers** | The maintainers of the plugin. | No | `[]` | | **optionsRenamedToSettings** | List of options renamed to settings. | No | `[]` | | **packPathName** | The name of the plugin directory in [packpath](https://neovim.io/doc/user/options.html#'packpath'), usually the plugin's github repo name. E.g. `"foo-bar.vim"`. | No | `name` parameter | | **package** | The nixpkgs package attr for this plugin. Can be a string, a list of strings, a module option, or any derivation. For example, "foo-bar-vim" for `pkgs.vimPlugins.foo-bar-vim`, or `[ "hello" "world" ]` will be referenced as `pkgs.hello.world`. | No | `name` parameter |