File

doc/coding_style.txt @ 9518:a62fa766d8f3

mod_vcard_legacy: Create nodes with open access (fixes #1221) Less drastic change from mod_vcard where everything is always public. This allows users to configure nodes without needing to for the old behaviour. Thanks to 038446c50630 users may still override this. Due to #1222 this may still not apply if the node has already been created by an automatic subscription
author Kim Alvefur <zash@zash.se>
date Thu, 18 Oct 2018 19:07:01 +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.