Code agreement and guidelines
4 | 5 |6 | 7 |
⚠️ PLEASE READ BEFORE CONTINUING ⚠️
8 | 9 |10 | 11 | Any code that **_you contribute_** will be under _**full 12 | control**_ by the repository maintainers. They may change 13 | it's licensing, the code itself, or use it for whatever 14 | the organization sees as necesarry. This does not mean 15 | rights, you will still have access to and retain full 16 | ownership of your work. This agreement is in place to 17 | prevent attempted project hijacking and legal issues. 18 | Code taken from existing sources do not fall under 19 | these rules, as that would be unethical and illegal. 20 | All code taken from outside sources fall under their 21 | original licese(s) and shall have a reference to it's 22 | orignal license. 23 | 24 |
25 | 26 |
Including externaly sourced code
27 | 28 | You are allowed to include source code from external 29 | sources, as long as you make sure it's original license 30 | is compatible with this project's license (GPL - V2). 31 | It is recommended to remove the whole license copy from 32 | the source files (if it has it) and add a comment referencing 33 | the source's original author, source, and short name of the 34 | original license. If the source files themselves do not have a 35 | copy of the license within them, you must add comments showing 36 | the original author, source, and short name of the license. 37 | 38 |39 | 40 |
Spacing & Formatting
41 | 42 | All functions, local and global variables, and 43 | namespaces must be capitalized with the 'PascalCase' 44 | naming Convention, and spelled properly. They 45 | must contain professional and easy to read names, 46 | usually they should describe what the function 47 | does, if possible. 48 | 49 | 50 | Variables and using statements should be clustered Like this, with descending length: 51 | 52 |
53 |
54 | There shall also not be more than one class/struct/enum or namespace
55 | in the same file.
56 |
57 | 58 | 59 | Keep all code as simple as possible and make sure all code is understandable. 60 | 61 |
62 | 63 |
Bundling
64 | 65 | If a class has more than one type of data, use `#region` tags like so: 66 | 67 |
68 |
69 | 70 | 71 | Do NOT create hacky methods to get around something unless you know you will change it before you commit. You _will_ regret making something very unreliable then having to re-make it for several hours in a more stable manner) 72 | 73 |
74 | 75 | Always use IF statments "properly" and clearly. and example is if you have many nested IFs, invert the condition and move it to the top, and return it if the condition is met. 76 | 77 |
78 | 79 | Don't define namespaces within namespaces, and always include only one namespace definition _per file_, just below the using statements. They should not use brackets like so: 80 | ```cs 81 | namespace PrismOS; 82 | ``` 83 | 84 |
85 | 86 |