Mercurial > prosody-modules

comparison CONTRIBUTING @ 1809:0b7d65b4f576

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CONTRIBUTING: Run through pandoc to normalize markdown syntax
author Kim Alvefur <zash@zash.se>
date Mon, 31 Aug 2015 17:29:48 +0200
parents e6e45ef1608b
children
comparison
equal deleted inserted replaced
1808:e6e45ef1608b 1809:0b7d65b4f576
2 ============ 2 ============
3 3
4 Guidelines for developers 4 Guidelines for developers
5 ------------------------- 5 -------------------------
6 6
7 * Each module should be contained in a folder of its name (e.g. 7 - Each module should be contained in a folder of its name (e.g.\
8 `mod_ping/mod_ping.lua`) 8 `mod_ping/mod_ping.lua`)
9 * Each module should have a `README.markdown` page in their 9 - Each module should have a `README.markdown` page in their folder
10 folder with a description, usage, configuration and todo 10 with a description, usage, configuration and todo sections (feel
11 sections (feel free to copy an existing one as a template) 11 free to copy an existing one as a template)
12 * Commit messages should begin with the name of the plugin they 12 - Commit messages should begin with the name of the plugin they are
13 are for (e.g. `mod_ping: Set correct namespace on pongs`) 13 for (e.g. `mod_ping: Set correct namespace on pongs`)
14 14
15 Instructions on cloning the repository are at 15 Instructions on cloning the repository are at
16 <https://prosody.im/doc/installing_modules#prosody-modules> 16 <https://prosody.im/doc/installing_modules#prosody-modules>