Mercurial > prosody-modules

view CONTRIBUTING @ 1808:e6e45ef1608b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CONTRIBUTING: Update guidelines and URL to hg repo
author Kim Alvefur <zash@zash.se>
date Mon, 31 Aug 2015 17:28:14 +0200
parents a25d137439a7
children 0b7d65b4f576
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>