mirror of
https://github.com/keepassxreboot/keepassxc.git
synced 2025-12-04 15:39:34 +01:00
Updated Pull Request Template and Contribute documents
* 📝 Update Installation instruction from the Wiki * 📝 Update PR template with emojis 🎉 * 📝 Update CONTRIBUTING.md with CodeStyle
This commit is contained in:
54
.github/CONTRIBUTING.md
vendored
54
.github/CONTRIBUTING.md
vendored
@@ -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
|
||||
|
||||
26
.github/PULL_REQUEST_TEMPLATE.md
vendored
26
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user