Skip to content

Commit 5ec7b8f

Browse files
committed
Begin "Style Guide" in CONTRIBUTING.md
1 parent 86e1153 commit 5ec7b8f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,20 @@ Add a folder with a unique name to `test/tests`.
2929
Copy the `Main.hx`, `Test.hxml`, and `.gitignore` from `test/tests/HelloWorld` to get started.
3030

3131
Once you've completed your test, run `haxe Test.hxml test=YourTestFolderName update-intended` to generate the `intended` folder containing the desired output for your test. Run without `update-intended` to compare the outputs.
32+
33+
## Style Guide
34+
35+
### Variable Names
36+
37+
Variable names should be:
38+
* Long and descriptive!
39+
* Please no one character variable names (outside of `for(i in ...)`)!
40+
* If a variable is of type `Null<T>`, its name must start with "maybe"!
41+
42+
### Imports
43+
44+
There should be an empty line between `import` and `using` imports with `using`s coming second. Within each second, the imports should be in alphabetical order and additionally separated into sections ordered as followed:
45+
* Imports from modules within this project.
46+
* Haxe standard library imports.
47+
* Reflaxe imports.
48+
* Third-party library imports.

0 commit comments

Comments
 (0)