File

doc/coding_style.txt @ 8811:f2d35eee69c9

mod_pubsub: Set an id attribute on outgoing event messages https://xmpp.org/extensions/xep-0060.html#impl-bounce > a pubsub service SHOULD ensure that the <message/> stanza for each > event notification it generates possesses an 'id' attribute with a > value
author Kim Alvefur <zash@zash.se>
date Mon, 21 May 2018 00:24:50 +0200
parent 8728:41c959c5c84b
line wrap: on
line source

This file describes some coding styles to try and adhere to when contributing to this project.
Please try to follow, and feel free to fix code you see not following this standard.

== Indentation ==

	1 tab indentation for all blocks

== Spacing ==

No space between function names and parenthesis and parenthesis and parameters:

		function foo(bar, baz)

Single space between braces and key/value pairs in table constructors:

		{ foo = "bar", bar = "foo" }

== Local variable naming ==

In this project there are many places where use of globals is restricted, and locals used for faster access.

Local versions of standard functions should follow the below form:

	math.random -> m_random
	string.char -> s_char	

== Miscellaneous ==

Single-statement blocks may be written on one line when short
	
	if foo then bar(); end

'do' and 'then' keywords should be placed at the end of the line, and never on a line by themself.