mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

contributing: reduce emphasis on settingsOptions

Browse source 
- Add an additional caution in CONTRIBUTING.md#declaring-plugin-options
- Remove `settingsOptions` from plugins/TEMPLATE.nix
This commit is contained in:
Matt Sturgeon 2025-04-21 10:02:30 +01:00
parent 55ad604d44
commit 86a887025f
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
2 changed files with 4 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -185,6 +185,8 @@ list-plugins -k vim
> Declaring `settings`-options is **not required**, because the `settings` option is a freeform type.
>
> While `settings` options can be helpful for documentation and type-checking purposes, this is a double-edged sword because we have to ensure the options are correctly typed and documented to avoid unnecessary restrictions or confusion.
>
> We usually recommend **not** declaring `settings` options, however there are exceptions where the trade-off is worth it.
> [!TIP]
> Learn more about the [RFC 42](https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md) which motivated this new approach.