From 5df0c0e7f0b437a7be5494d31cb12dd2b51e4836 Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Thu, 16 Feb 2023 10:35:46 +0100 Subject: [PATCH] docs: pause on new resolvers --- src/core/resolvers/_READ_BEFORE_CONTRIBUTE.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 src/core/resolvers/_READ_BEFORE_CONTRIBUTE.md diff --git a/src/core/resolvers/_READ_BEFORE_CONTRIBUTE.md b/src/core/resolvers/_READ_BEFORE_CONTRIBUTE.md new file mode 100644 index 00000000..fe855309 --- /dev/null +++ b/src/core/resolvers/_READ_BEFORE_CONTRIBUTE.md @@ -0,0 +1,28 @@ +# Pause on New Resolvers + +Thank you for your interest in contributing to this project! + +Due to the maintenance burden of new resolvers, **⚠️ we no longer accept new resolvers** adding to this repo. + +Instead, we suggest UI libraries to maintain and publish their own resolvers, as the resolvers are more coupled to their structure. + +We recommend to have it under a submodule, or publish as a separate package. + +```ts +import Components from 'unplugin-vue-components' +import MyLibResolver from 'my-lib/auto-import-resolver' // <-- + +export default defineConfig({ + plugins: [ + Components({ + resolvers: [ + MyLibResolver + ] + }) + ] +}) +``` + +Even for existing resolvers, we would also recommend to move them to their own packages to have the faster release cycle. Once you have done so, we are happy to accept PR to deprecate and forward the resolver to your package. + +Thanks you.