Mercurial > prosody-modules
annotate CONTRIBUTING @ 3661:88d414c916ee
mod_http_upload: Back out 3fb0add97cdb - depends on yet uncommon lfs version
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 30 Aug 2019 18:34:55 +0200 |
parents | 0b7d65b4f576 |
children |
rev | line source |
---|---|
1669
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 Contributing |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 ============ |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 Guidelines for developers |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 ------------------------- |
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 |
1809
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
7 - Each module should be contained in a folder of its name (e.g.\ |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
8 `mod_ping/mod_ping.lua`) |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
9 - Each module should have a `README.markdown` page in their folder |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
10 with a description, usage, configuration and todo sections (feel |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
11 free to copy an existing one as a template) |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
12 - Commit messages should begin with the name of the plugin they are |
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
13 for (e.g. `mod_ping: Set correct namespace on pongs`) |
1669
a25d137439a7
Add README and CONTRIBUTING files containing the text from https://code.google.com/p/prosody-modules/
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 |
1809
0b7d65b4f576
CONTRIBUTING: Run through pandoc to normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
15 Instructions on cloning the repository are at |
1808
e6e45ef1608b
CONTRIBUTING: Update guidelines and URL to hg repo
Kim Alvefur <zash@zash.se>
parents:
1669
diff
changeset
|
16 <https://prosody.im/doc/installing_modules#prosody-modules> |