File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -59,12 +59,34 @@ Please consider this before opening a pull request:
5959- After your first PR is merged, you are automatically added to the [ list of
6060 contributors] [ 8 ] .
6161
62+ ### Contribute a new plugin
63+
64+ Missing a plugin for a tool you use? Contributing one is often the fastest path
65+ to support — Knip ships with 150+ plugins, and most of them started as a PR from
66+ a user of the tool.
67+
68+ To get started:
69+
70+ 1 . Read the [ Writing A Plugin] [ 9 ] guide on knip.dev.
71+
72+ 2 . Scaffold the plugin, tests and fixtures with the built-in generator:
73+
74+ ``` sh
75+ cd packages/knip
76+ pnpm create-plugin --name your-tool
77+ ```
78+
79+ 3 . Follow the general [ development] [ 6 ] instructions.
80+
81+ Feel free to open a draft PR early to get feedback, and look at similar plugins
82+ for inspiration.
83+
6284[ 1 ] : ./CODE_OF_CONDUCT.md
6385[ 2 ] : https://knip.dev
6486[ 3 ] : #open-an-issue
6587[ 4 ] : #open-a-pull-request
6688[ 5 ] : https://github.com/webpro-nl/knip/releases
6789[ 6 ] : /.github/DEVELOPMENT.md
68- [ 7] :
69- https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request
90+ [ 7 ] : https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request
7091[ 8 ] : https://knip.dev/#created-by-awesome-contributors
92+ [ 9 ] : https://knip.dev/writing-a-plugin
Original file line number Diff line number Diff line change 11blank_issues_enabled : false
2+ contact_links :
3+ - name : 🧩 Contribute a new plugin
4+ url : https://github.com/webpro-nl/knip/blob/main/.github/CONTRIBUTING.md#contribute-a-new-plugin
5+ about : Missing a plugin for a tool you use? Consider contributing one — it's often the fastest path to support.
6+ - name : 👾 Chat
7+ url : https://chat.e18e.dev/
8+ about : Join the `#knip` channel on the e18e Discord to chat with the community.
You can’t perform that action at this time.
0 commit comments