view CONTRIBUTING @ 4756:098e3b3aac9c

luacheck: Make module:metric() known
author Kim Alvefur <zash@zash.se>
date Sun, 07 Nov 2021 14:17:29 +0100
parents 0b7d65b4f576
children
line wrap: on
line source

Contributing
============

Guidelines for developers
-------------------------

-   Each module should be contained in a folder of its name (e.g.\
     `mod_ping/mod_ping.lua`)
-   Each module should have a `README.markdown` page in their folder
    with a description, usage, configuration and todo sections (feel
    free to copy an existing one as a template)
-   Commit messages should begin with the name of the plugin they are
    for (e.g. `mod_ping: Set correct namespace on pongs`)

Instructions on cloning the repository are at
<https://prosody.im/doc/installing_modules#prosody-modules>