autopush/CONTRIBUTING.md

CONTRIBUTING

Contribution rules for the autopush project.

General

By contributing you agree that your work will be published under the GPL2.

Where possible, text width should not exceed 70 characters.

Code style

XML

For .xml files the following rules apply.

• While there is no preference for indent style or code formatting, it must be consistent within each file.
• No whitespace-only lines and trailing whitespace allowed.
• Whitespace between tags and their data is forbidden, for example <tag> 10.0 </tag> is not acceptable.
• If a tag has children, it has to be on it's own line.

Example:

<parent>
	<child n="1">3</child>
	<child n="2">100</child>
	<othertag/>
</parent>

Nasal

For .nas files the following rules apply.

• While there is no preference for indent style or code formatting, it must be consistent within each file.
• No whitespace-only lines and trailing whitespace allowed.
• For names use camelCase or snake_case.
• Prefix "private" vars and functions with a _.
• Use coments for blocks of codes and only when something is not clear (eg. starting iterating from 3).

Example:

# This function does something non obvious.
var function = func() {
	if (a == b) {
		var a = geo.Coord.new();
	} else {
		var b = 0;
	}
}

Git

Please add a descriptive commit message to every commit.