Skip to content

Commit 4404421

Browse files
committed
Clarify scope (and remove "things you should avoid")
This repository shouldn't get into the business of dictating plugin authors how to write their code, but rather stick to providing a uncontroversial CI/editor config most authors will want to have.
1 parent 14d67e4 commit 4404421

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ The template includes the following:
1313

1414
To get started writing a Lua plugin, I recommend reading the [nvim-lua-guide][nvim-lua-guide].
1515

16+
## Scope
1617

17-
Things you should avoid:
18+
Anything that the majority of plugin authors will want to have is in scope of
19+
this starter template. Anything that is controversial is out-of-scope.
1820

19-
- Automatically setting up global mappings. Instead prefer a `.setup {}` function where users can opt-in to default mappings, or let them configure the mappings on their own.
20-
- To be extended ...
21+
---
2122

2223

2324
The remainder of the README is text that can be preserved in your plugin:

0 commit comments

Comments
 (0)