From e7999a032bd888abf3665c501a754dbb922fe7c9 Mon Sep 17 00:00:00 2001 From: Cem Keylan Date: Tue, 2 Feb 2021 03:39:56 +0300 Subject: Switch to org-mode for generating the website --- docs/docs/carbslinux/Conventions.html | 97 +++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 docs/docs/carbslinux/Conventions.html (limited to 'docs/docs/carbslinux/Conventions.html') diff --git a/docs/docs/carbslinux/Conventions.html b/docs/docs/carbslinux/Conventions.html new file mode 100644 index 0000000..b91b9a7 --- /dev/null +++ b/docs/docs/carbslinux/Conventions.html @@ -0,0 +1,97 @@ + + + + + + +Conventions (Carbs Linux User Manual) + + + + + + + + + + + + + + + + + + +
+

+Up: Contribution Guidelines   [Contents]

+
+
+

3.1 Conventions

+ + + +
+
[0010]
+

Try to keep the file readable. +

+
[0011]
+

Characters on a line shouldn’t exceed 100 characters. +

+
[0012]
+

Make sure you don’t have code commented out during +commit. Uncomment them or remove them completely. +

+
[0013]
+

Do not add comments following the code, add them to the +top of the code. It makes it harder to read, and lines longer. Here is an example: +

+
+ +
+
# Good way of commenting.
+your code goes here
+
+your code goes here  # Avoid this way of commenting.
+
+
+
+ + + + +
• Shell Conventions  Conventions for shell scripts +
• Repository Conventions  Conventions for repository build scripts +
+ + + + + + -- cgit v1.2.3