forked from PyTTaMaster/PyTTa
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CodingGuidelines
21 lines (15 loc) · 862 Bytes
/
CodingGuidelines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
For now we don't have many rules, but you should consider the subsequent one.
The naming convention used is:
- ClassName;
- method_name;
- propertyName;
- function_name;
- variableName;
- modulename.
The commit messages must carry some annotations. This way, in the future, we can use these to generate release notes. They are:
Annotation Description Exemple git commit
[INTERNAL] used for internal stuff git commit -m "[INTERNAL] update .gitignore"
[FIX] contains bugfix git commit -m "[FIX] SignalObj.__truediv__ bug fix"
[FEATURE] contains new feature git commit -m "[FEATURE] introduced Analysis"
[DOC] contains documentation git commit -m "[DOC] introduced Analysis documentation"
As far as concrete guidelines, just imitate the existing code. Keep things organized.