From d3b52571d0da14bc93694a1823524348235d198b Mon Sep 17 00:00:00 2001 From: Jonathan Holmgren Date: Mon, 30 May 2022 21:31:38 -0500 Subject: [PATCH] Updated ContributionGuidelines (markdown) --- ContributionGuidelines.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ContributionGuidelines.md b/ContributionGuidelines.md index 0a299c0..23d6ef9 100644 --- a/ContributionGuidelines.md +++ b/ContributionGuidelines.md @@ -8,6 +8,7 @@ Contributions are welcome and encouraged, provided your code is of sufficient qu 1. Encoding should be UTF-8/UTF-16 1. Uses 2-spaces for code blocks & indentation 1. Uses descriptive function and variable names in the **P**ascal**C**ase convention +1. Follows the established naming convention for interface components, variables, sections, etc. 1. Avoids the use of `Not` and uses positive conditionals wherever possible (e.g. `If,%foo%,Equal,0` instead of `If,Not,%foo%,Equal,1`) 1. Uses common sense when it comes to embedded files. **Do not embed files or licensed software you do not have permission to distribute**. Do not create .script "container files" that only contain attachments; if your running into performance issues with attachment size use a standalone .7z file instead. Where possible downloading the files and caching them is preferred. 1. Does not use section parameters (#1, #2 , #9, etc.) as temporary variables for storing values. If you need temporary variables use `SetLocal` and declare an actual variable. If you need more then 1 section parameter please use `GetParam` and assign each parameter to a variable. This makes the code much easier to read and debug.