CONTRIBUTING
author Matthew Wild <mwild1@gmail.com>
Thu, 08 Jun 2023 16:20:42 +0100
changeset 5540 96dec7681af8
parent 1813 0b7d65b4f576
permissions -rw-r--r--
mod_firewall: Update user marks to store instantly via map store The original approach was to keep marks in memory only, and persist them at shutdown. That saves I/O, at the cost of potentially losing marks on an unclean shutdown. This change persists marks instantly, which may have some performance overhead but should be more "correct". It also splits the marking/unmarking into an event which may be watched or even fired by other modules.

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>