Skip to content

Adding a module

axtloss edited this page Aug 22, 2024 · 1 revision

Adding new modules

To add a new module:

  • fork this repo
  • add your own module in its own directory
  • add your username to the CODEOWNERS file in the format /<directory name>/ @<your username>
  • make a pull request

Adding modules that use custom plugins

A module may not use a plugin that isn't either part of the core vib plugins, or in the module directory itself.

If your module necessarily requires a custom plugin, add the plugin source file to the module directory and include a README.md detailing on how to install the plugin. It is recommended that custom plugins use the vib shim, to avoid having to compile plugins to use the module.

Clone this wiki locally