diff options
author | TheZ3ro <io@thezero.org> | 2016-10-26 15:19:28 +0300 |
---|---|---|
committer | Jonathan White <droidmonkey@users.noreply.github.com> | 2016-10-26 15:19:28 +0300 |
commit | 6c7c5443d4e13d6155497cc6290148d1a3ffcc57 (patch) | |
tree | b95a2355ffe1003bf11ce984e346e98a1a7db387 /.github | |
parent | fdad028e7367e95068de45e61a065418ac6c579f (diff) |
Updated Pull Request Template and Contribute documents
* :memo: Update Installation instruction from the Wiki
* :memo: Update PR template with emojis :tada:
* :memo: Update CONTRIBUTING.md with CodeStyle
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 54 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 26 |
2 files changed, 68 insertions, 12 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e48474b82..f47f0141a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -108,7 +108,59 @@ Please join an existing language team or request a new one if there is none. This project follows the [Qt Coding Style](https://wiki.qt.io/Qt_Coding_Style). All submissions are expected to follow this style. -Addendum- Class member variables must start with ```m_``` +In particular Code must follow the following specific rules: + +#### Naming Convention +`lowerCamelCase` + +For names made of only one word, the fist letter is lowercase. +For names made of multiple concatenated words, the first letter is lowercase and each subsequent concatenated word is capitalized. + +#### Indention +For C++ files (.cpp .h): 4 spaces +For Qt-UI files (.ui): 2 spaces + +#### Pointers +```c +int* count; +``` + +#### Braces +```c +if (condition) { + doSomething(); +} + +void ExampleClass::exampleFunction() +{ + doSomething(); +} +``` + +#### Switch statement +```c +switch (a) { +case 1: + doSomething(); + break; + +default: + doSomethingElse(); + break; +} +``` + +#### Member variables +Use prefix: `m_*` + +Example: `m_variable` + +#### GUI Widget names +Widget names must be related to the desired program behaviour. +Preferably end the name with the Widget Classname + +Example: `<widget class="QCheckBox" name="rememberCheckBox">` + [beginner]:https://github.com/keepassxreboot/keepassx/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner+label%3A%22help+wanted%22+sort%3Acomments-desc diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4f9ceac42..51436aada 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,17 +15,21 @@ ## Screenshots (if appropriate): ## Types of changes -<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to change) +<!--- What types of changes does your code introduce? If it apply to your pull request, --> +<!--- replace all the `:negative_squared_cross_mark:` with `:white_check_mark:` --> +<!--- Everybody loves emoji --> +- :negative_squared_cross_mark: Bug fix (non-breaking change which fixes an issue) +- :negative_squared_cross_mark: New feature (non-breaking change which adds functionality) +- :negative_squared_cross_mark: Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: -<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> +<!--- Go over all the following points, if it apply to your pull request, --> +<!--- replace all the `:negative_squared_cross_mark:` with `:white_check_mark:`. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> -- [ ] My code follows the code style of this project. -- [ ] My change requires a change to the documentation. -- [ ] I have updated the documentation accordingly. -- [ ] I have read the **CONTRIBUTING** document. -- [ ] I have added tests to cover my changes. -- [ ] All new and existing tests passed. +<!--- Pull Requests that fail the [REQUIRED] field will likely be sent back for corrections or rejected --> +- :negative_squared_cross_mark: I have read the **CONTRIBUTING** document. [REQUIRED] +- :negative_squared_cross_mark: My code follows the code style of this project. [REQUIRED] +- :negative_squared_cross_mark: All new and existing tests passed. [REQUIRED] +- :negative_squared_cross_mark: My change requires a change to the documentation. +- :negative_squared_cross_mark: I have updated the documentation accordingly. +- :negative_squared_cross_mark: I have added tests to cover my changes. |