Mercurial > prosody-modules
view CONTRIBUTING @ 5907:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
author | Ben Smith <bens@effortlessis.com> |
---|---|
date | Mon, 13 May 2024 13:25:13 -0700 |
parents | 0b7d65b4f576 |
children |
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>