| author | Kim Alvefur <zash@zash.se> |
| Mon, 31 Aug 2015 17:28:14 +0200 | |
| changeset 1812 | e6e45ef1608b |
| parent 1673 | a25d137439a7 |
| child 1813 | 0b7d65b4f576 |
| permissions | -rw-r--r-- |
|
1673
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 |
|
|
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
|
7 |
* Each module should be contained in a folder of its name (e.g. |
|
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
|
8 |
`mod_ping/mod_ping.lua`) |
|
1812
e6e45ef1608b
CONTRIBUTING: Update guidelines and URL to hg repo
Kim Alvefur <zash@zash.se>
parents:
1673
diff
changeset
|
9 |
* Each module should have a `README.markdown` page in their |
|
e6e45ef1608b
CONTRIBUTING: Update guidelines and URL to hg repo
Kim Alvefur <zash@zash.se>
parents:
1673
diff
changeset
|
10 |
folder with a description, usage, configuration and todo |
|
e6e45ef1608b
CONTRIBUTING: Update guidelines and URL to hg repo
Kim Alvefur <zash@zash.se>
parents:
1673
diff
changeset
|
11 |
sections (feel free to copy an existing one as a template) |
|
1673
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
|
12 |
* Commit messages should begin with the name of the plugin they |
|
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
|
13 |
are for (e.g. `mod_ping: Set correct namespace on pongs`) |
|
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 |
|
|
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
|
15 |
Instructions on cloning the repository are at |
|
1812
e6e45ef1608b
CONTRIBUTING: Update guidelines and URL to hg repo
Kim Alvefur <zash@zash.se>
parents:
1673
diff
changeset
|
16 |
<https://prosody.im/doc/installing_modules#prosody-modules> |