Changeset View
Changeset View
Standalone View
Standalone View
doc/contrib.md
Show All 9 Lines | |||||
10 | 10 | | |||
11 | ### General Coding Guidelines | 11 | ### General Coding Guidelines | ||
12 | The following guidelines apply to all submited code. | 12 | The following guidelines apply to all submited code. | ||
13 | 13 | | |||
14 | - Follow the [KDE style guidelines] | 14 | - Follow the [KDE style guidelines] | ||
15 | - Use constant referances when possible | 15 | - Use constant referances when possible | ||
16 | - Includes should be alphabetical. | 16 | - Includes should be alphabetical. | ||
17 | - Run the style script before you commit. | 17 | - Run the style script before you commit. | ||
18 | - Headers should use #pragma once not #ifndef Def. | 18 | - Headers should use `#pragma once`. | ||
patrickelectric: final dot. | |||||
19 | - Auto should not be used if the type is not explict. | 19 | - Auto should not be used if the type is not explict. | ||
20 | - Doxygen comments should be created/updated with code. | 20 | - Doxygen comments should be created/updated with code. | ||
21 | - Objects should have logical varible and function names | 21 | - Objects should have logical varible and function names | ||
22 | - Code should alway be readable ,comment your code. | 22 | - Code should alway be readable ,comment your code. | ||
23 | 23 | | |||
24 | ### Commit Guidelines | 24 | ### Commit Guidelines | ||
25 | Keeping a clean project history requires that we take care when choosing how we will commit our code.Consider the following when creating commits. ALL COMMITS MUST BE REVIEWED BEFORE PUSHING TO MASTER. | 25 | Keeping a clean project history requires that we take care when choosing how we will commit our code.Consider the following when creating commits. ALL COMMITS MUST BE REVIEWED BEFORE PUSHING TO MASTER. | ||
26 | 26 | | |||
Show All 14 Lines |
final dot.