-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathConventions.txt
68 lines (59 loc) · 2.01 KB
/
Conventions.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
Naming conventions
Minecraft : HxC[modname] example: HxCArcanea [Arcanea] (Magic Energy Rename)
All Else Until Specified : Just name as you please.
Versioning
A.B.C.X < Example : 3.2.0a [3rd rewrite.2nd major update.no changes.hotfix 1]
A:Major rewrite version
- 0 until public release no rewrite required.
- Critical Changes that WILL break old saves.
- Progression Overhaul
B:Major update
- Adds 3+ new things
- Changes critical functionality of something that may break old saves.
- Game breaking bugfixes.
- Removal of things
- Progression Changes
C:Minor update
- Bugfixes
- Few new things added
- Must work with old saves
- Localization
X:Hotfix/Jenkins version
- self explanatory
- Letters a-z-A-Z
A.B.C: Must be numbers, can go over 10, reset if the higher critera changes. IE 1.1 -> 2.0...
X:Must be a letter lowercase first a-Z Letters removed if C changes.
All must abide by this versioning system, Not all criteria needs to be met, but if criteria met that is what changes.
Github Repo Labeling
Game_Modname
example Minecraft_HxCCore or MC_HxCCore
Github Repo Structure
([name] < means folder)
[libs] (if any)
[src] (if contains code changes)
setup/build batch files (if needed)
.gitignore (always)
LICENSE (always)(preferably MIT ATM, may change, if you created repo of own volition you may pick the License)
README.md (must contain title + main author + major features)
TODO (if any)
Must have this structure minimum nothing less unless valid reasoning.
Coding Style Preferences
int a, b, c;
String d = "bob says hi",
e = "john is dead";
public....() {
code...;
}
NOT
int a;
int b;
int c;
String d = "bob says hi";
String e = "john is dead";
public....()
{
code...;
}
I highly prefer the top style over the above style, and will adamantly change it to my liking.
if code is longer than width of screen break to next line on the following character sets
(, || && &| &!) NOT (== <= > !=)