elie/PhoenixPE
1
0
Fork 0
mirror of https://github.com/PhoenixPE/PhoenixPE.git synced 2025-09-17 18:48:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated ContributionGuidelines (markdown)

Jonathan Holmgren
2022-05-30 21:31:38 -05:00
parent fa155e9caf
commit d3b52571d0
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
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. Encoding should be UTF-8/UTF-16
1. Uses 2-spaces for code blocks & indentation 1. Uses 2-spaces for code blocks & indentation
1. Uses descriptive function and variable names in the **P**ascal**C**ase convention 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. 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. 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. 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.