From 9eb14ac2f3f10b45def1513e0f4fb9e955876a19 Mon Sep 17 00:00:00 2001 From: PrincipalSpears Date: Thu, 29 Jul 2021 17:28:43 +0000 Subject: [PATCH] Update 'Code Requirements' --- Code-Requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Code-Requirements.md b/Code-Requirements.md index 187eb12..feca085 100644 --- a/Code-Requirements.md +++ b/Code-Requirements.md @@ -1,4 +1,4 @@ * If something you write isn't easily understandable to a noobie, please document it or get someone else to. Since SnootGame is an amneture project, we'd like to keep it friendly to amnetures. Post links to non-technical explinations of what obscure pieces of code do, explain what certain althorithms are and how they work, and over all just make sure that even a codelet could understand what something does by reading the comments. * Try your best to not make code look ugly. Ugly code is a pain to read and makes life harder, please avoid it when you can. If its simply not possible, then do document what is happening. * Code should be maintainable by others, modular, hackable, and, if need be, able to be used as a template. This is to allow easy debugging, easy code reuse, and ease of maintanace for when things eventually break. Avoid spaghetti when possible. -* Typical coding convention of sane variable names go with it too. Abbrevations are acceptable if their point is obvious, but its always nice to have a full name for something. Most variables are worte in camelCase, conform to this whenever possible. +* Typical coding convention of sane variable names go with it too. Abbrevations are acceptable if their point is obvious, but its always nice to have a full name for something. Most variables are wrote in camelCase, conform to this whenever possible.