File

doc/coding_style.txt @ 8867:c601c834bf01

MUC: Add support for setting MUC room defaults from the config file Defaults are roughtly like this: muc_rooom_default_public = true muc_rooom_default_persistent = false muc_rooom_default_members_only = false muc_rooom_default_moderated = false muc_rooom_default_public_jids = false muc_rooom_default_change_subject = false muc_room_default_history_length = 20 muc_room_default_language = nil
author Kim Alvefur <zash@zash.se>
date Sun, 03 Jun 2018 14:43:06 +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.