Browse files

Updated readme

  • Loading branch information...
1 parent fca9b4d commit e72aca8dd4201e26e4131da541e48ebea191d3e5 @LadyCailin LadyCailin committed Feb 8, 2013
Showing with 55 additions and 0 deletions.
  1. +52 −0 CONTRIBUTING.txt
  2. +3 −0 README.md
View
52 CONTRIBUTING.txt
@@ -0,0 +1,52 @@
+To help standardize the code formatting, please follow these guidelines for code
+formatting.
+
+For the most part, the standard Java code conventions should be followed. They can be found at
+http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html
+There are a few exceptions and clarifications however:
+
+* Line Length
+Avoid lines longer than 80 characters. When wrapping lines, follow these conventions:
+
+ * Break after a comma
+ * Break before an operator
+ * Indent to the current level + 2 tabs on the following lines, if the code
+ directly beneath it is on a different indention level
+ * If breaking in the middle of a long string, the space should start the newline.
+ String s = "This is a long string, which has a"
+ + " break in the middle";
+
+* Indentions
+Use tabs for indentions, NOT spaces. This allows for tab length to be set by the client,
+and also allows for quicker backspacing if deleting indentation.
+
+* Brace style
+Braces should be on the same line as the statement.
+ if(condition) {
+ ...
+ }
+ NOT
+ if(condition)
+ {
+ ...
+ }
+
+This condenses the file size, and makes more code fit onscreen at once. Since the
+code inside of the block should be indented anyways, there is no readability issue
+as far as determining what code is actually inside the block or not.
+
+All braceable statements MUST use braces, and newlines.
+ if(condition) {
+ code;
+ }
+ NOT
+ if(condition) code;
+ USUALLY NOT
+ if(condition){ code; }
+
+if you have a series of several if statements that only have one statement, and
+it makes sense to have them all lined up, the third example may be used, but is
+still discouraged. Regardless, the statements must ALWAYS have braces.
+
+* Commits
+If you have more than 2 commits, please rebase.
View
3 README.md
@@ -31,5 +31,8 @@ By submitting code, you agree to dual license your code under the
the MIT License, barring the special restriction regarding code submissions,
explained in the SPECIAL_LICENSE.txt file, which is attached.
+For details about code formatting standards, and other basic information for
+contributors, please see the CONTRIBUTING.txt file.
+
Portions of CommandHelper are copyright: wraithguard01, sk89q, Deaygo,
t3hk0d3, zml2008, EntityReborn, and albatrossen

0 comments on commit e72aca8

Please sign in to comment.