-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
218 changed files
with
34,742 additions
and
1,294 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,8 @@ | ||
src/version.h.cmake export-subst | ||
.gitattributes export-ignore | ||
.gitignore export-ignore | ||
.travis.yml export-ignore | ||
.tx export-ignore | ||
snapcraft.yaml export-ignore | ||
make_release.sh export-ignore | ||
AppImage-Recipe.sh export-ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,177 @@ | ||
# Contributing to KeePassX Reboot | ||
|
||
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: | ||
|
||
The following is a set of guidelines for contributing to KeePassX Reboot on GitHub. | ||
These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
#### Table Of Contents | ||
|
||
[What should I know before I get started?](#what-should-i-know-before-i-get-started) | ||
* [Open Source Contribution Policy](#open-source-contribution-policy) | ||
|
||
[How Can I Contribute?](#how-can-i-contribute) | ||
* [Feature Requests](#feature-requests) | ||
* [Bug Reports](#bug-reports) | ||
* [Your First Code Contribution](#your-first-code-contribution) | ||
* [Pull Requests](#pull-requests) | ||
* [Translations](#translations) | ||
|
||
[Styleguides](#styleguides) | ||
* [Git Branch Strategy](#git_branch_strategy) | ||
* [Git Commit Messages](#git-commit-messages) | ||
* [Coding Styleguide](#coding-styleguide) | ||
|
||
|
||
## What should I know before I get started? | ||
### Open Source Contribution Policy | ||
[Version 0.3, 2015–11–18](https://medium.com/@jmaynard/a-contribution-policy-for-open-source-that-works-bfc4600c9d83#.i9ntbhmad) | ||
|
||
#### Policy | ||
|
||
We will accept contributions of good code that we can use from anyone. | ||
|
||
#### What this means | ||
|
||
- “We will accept”: This means that we will incorporate your contribution into the project’s codebase, adapt it as needed, and give you full credit for your work. | ||
- “contributions”: This means just about anything you wish to contribute to the project, as long as it is good code we can use. The easier you make it for us to accept your contribution, the happier we are, but if it’s good enough, we will do a reasonable amount of work to use it. | ||
- “of good code”: This means that we will accept contributions that work well and efficiently, that fit in with the goals of the project, that match the project’s coding style, and that do not impose an undue maintenance workload on us going forward. This does not mean just program code, either, but documentation and artistic works as appropriate to the project. | ||
- “that we can use”: This means that your contribution must be given freely and irrevocably, that you must have the right to contribute it for our unrestricted use, and that your contribution is made under a license that is compatible with the license the project has chosen and that permits us to include, distribute, and modify your work without restriction. | ||
- “from anyone”: This means exactly that. We don’t care about anything but your code. We don’t care about your race, religion, national origin, biological gender, perceived gender, sexual orientation, lifestyle, political viewpoint, or anything extraneous like that. We will neither reject your contribution nor grant it preferential treatment on any basis except the code itself. We do, however, reserve the right to tell you to go away if you behave too obnoxiously toward us. | ||
|
||
#### If Your Contribution Is Rejected | ||
|
||
If we reject your contribution, it means only that we do not consider it suitable for our project in the form it was submitted. It is not personal. If you ask civilly, we will be happy to discuss it with you and help you understand why it was rejected, and if possible improve it so we can accept it. | ||
|
||
#### Revision History | ||
* 0.1, 2011–11–18: Initial draft. | ||
* 0.2, 2011–11–18: Added “If Your Contribution Is Rejected” section. | ||
* 0.3, 2011–11–19: Added “irrevocably” to “we can use” and changed “it” to “your contribution” in the “if rejected” section. Thanks to Patrick Maupin. | ||
|
||
|
||
## How Can I Contribute? | ||
### Feature Requests | ||
|
||
We're always looking for suggestions to improve our application. If you have a suggestion for improving an existing feature, or would like to suggest a completely new feature for KeePassX Reboot, please use the Issues section or our [Google Groups](https://groups.google.com/forum/#!forum/keepassx-reboot) forum. | ||
|
||
### Bug Reports | ||
|
||
Our software isn't always perfect, but we strive to always improve our work. You may file bug reports in the Issues section. | ||
|
||
Before submitting a Bug Report, check if the problem has already been reported. Please refrain from opening a duplicate issue. If you want to highlight a deficiency on an existing issue, simply add a comment. | ||
|
||
### Discuss with the Team | ||
|
||
You can talk to the KeePassX Reboot Team about Bugs, new feature, Issue and PullRequests at our [Google Groups](https://groups.google.com/forum/#!forum/keepassx-reboot) forum | ||
|
||
### Your First Code Contribution | ||
|
||
Unsure where to begin contributing to KeePassX Reboot? You can start by looking through these `beginner` and `help-wanted` issues: | ||
|
||
* [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two. | ||
* [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues. | ||
|
||
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have. | ||
|
||
### Pull Requests | ||
|
||
Along with our desire to hear your feedback and suggestions, we're also interested in accepting direct assistance in the form of code. | ||
|
||
All pull requests must comply with the above requirements and with the [Styleguides](#styleguides). | ||
|
||
### Translations | ||
|
||
Translations are managed on [Transifex](https://www.transifex.com/keepassxc/keepassxc/) which offers a web interface. | ||
Please join an existing language team or request a new one if there is none. | ||
|
||
## Styleguides | ||
|
||
### Git Branch Strategy | ||
|
||
The Branch Strategy is based on [git-flow-lite](http://nvie.com/posts/a-successful-git-branching-model/). | ||
|
||
* **master** -> always points to the last release published | ||
* **develop** -> points to the next planned release, tested and reviewed code | ||
* **feature/**[name] -> points to brand new feature in codebase, candidate for merge into develop (subject to rebase) | ||
|
||
|
||
### Git Commit Messages | ||
|
||
* Use the present tense ("Add feature" not "Added feature") | ||
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
* Limit the first line to 72 characters or less | ||
* Reference issues and pull requests liberally | ||
* When only changing documentation, include `[ci skip]` in the commit description | ||
* Consider starting the commit message with an applicable emoji: | ||
* :memo: `:memo:` when writing docs | ||
* :penguin: `:penguin:` when fixing something on Linux | ||
* :apple: `:apple:` when fixing something on macOS | ||
* :checkered_flag: `:checkered_flag:` when fixing something on Windows | ||
* :bug: `:bug:` when fixing a bug | ||
* :fire: `:fire:` when removing code or files | ||
* :green_heart: `:green_heart:` when fixing the CI build | ||
* :white_check_mark: `:white_check_mark:` when adding tests | ||
* :lock: `:lock:` when dealing with security | ||
|
||
|
||
### Coding Styleguide | ||
|
||
This project follows the [Qt Coding Style](https://wiki.qt.io/Qt_Coding_Style). All submissions are expected to follow this style. | ||
|
||
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 | ||
[help-wanted]:https://github.com/keepassxreboot/keepassx/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Acomments-desc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
<!--- Provide a general summary of the issue in the title above --> | ||
|
||
## Expected Behavior | ||
<!--- If you're describing a bug, tell us what should happen --> | ||
<!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
|
||
## Current Behavior | ||
<!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
<!--- If suggesting a change/improvement, explain the difference from the current behavior --> | ||
|
||
## Possible Solution | ||
<!--- Not obligatory, but suggest a fix/reason for the bug, --> | ||
<!--- or ideas how to implement the addition or change --> | ||
|
||
## Steps to Reproduce (for bugs) | ||
<!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
<!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
1. | ||
2. | ||
3. | ||
4. | ||
|
||
## Context | ||
<!--- How has this issue affected you? What are you trying to accomplish? --> | ||
<!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
||
## Your Environment | ||
<!--- Include relevant details about the environment you experienced the bug in --> | ||
* KeePassXC version/commit used: (can be found under Help -> About) | ||
* Qt version (e.g. Qt 5.3): | ||
* Compiler (e.g. Clang++3.6.0): | ||
* Operating System and version: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<!--- Provide a general summary of your changes in the title above --> | ||
|
||
## Description | ||
<!--- Describe your changes in detail --> | ||
|
||
## Motivation and Context | ||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
|
||
## How Has This Been Tested? | ||
<!--- Please describe in detail how you tested your changes. --> | ||
<!--- Include details of your testing environment, and the tests you ran to --> | ||
<!--- see how your change affects other areas of the code, etc. --> | ||
|
||
## Screenshots (if appropriate): | ||
|
||
## Types of changes | ||
<!--- What types of changes does your code introduce? --> | ||
<!--- Please remove all lines which don't 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) | ||
|
||
## Checklist: | ||
<!--- Please go over all the following points. --> | ||
<!--- Again, remove any lines which don't apply. --> | ||
<!--- Pull Requests that don't fulfill all [REQUIRED] requisites are likely --> | ||
<!--- to be sent back to you for correction or will be rejected. --> | ||
- ✅ I have read the **CONTRIBUTING** document. **[REQUIRED]** | ||
- ✅ My code follows the code style of this project. **[REQUIRED]** | ||
- ✅ All new and existing tests passed. **[REQUIRED]** | ||
- ✅ My change requires a change to the documentation and I have updated it accordingly. | ||
- ✅ I have added tests to cover my changes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
CMakeLists.txt.* | ||
build/ | ||
build*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,45 @@ | ||
language: cpp | ||
sudo: required | ||
dist: trusty | ||
services: [docker] | ||
|
||
os: | ||
- linux | ||
# - osx | ||
|
||
# Define clang compiler without any frills | ||
compiler: | ||
- clang | ||
- gcc | ||
# - clang | ||
|
||
env: | ||
- CONFIG=Release | ||
- CONFIG=Debug | ||
|
||
git: | ||
depth: 3 | ||
|
||
before_install: | ||
- if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo apt-get -qq update; fi | ||
- if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo apt-get -qq install cmake libmicrohttpd10 libmicrohttpd-dev libxi-dev qtbase5-dev libqt5x11extras5-dev qttools5-dev qttools5-dev-tools libgcrypt20-dev zlib1g-dev libxtst-dev xvfb; fi | ||
- if [ "$TRAVIS_OS_NAME" = "osx" ]; then brew update; fi | ||
- if [ "$TRAVIS_OS_NAME" = "osx" ]; then brew ls | grep -wq cmake || brew install cmake; fi | ||
- if [ "$TRAVIS_OS_NAME" = "osx" ]; then brew ls | grep -wq qt5 || brew install qt5; fi | ||
- if [ "$TRAVIS_OS_NAME" = "osx" ]; then brew ls | grep -wq libgcrypt || brew install libgcrypt; fi | ||
|
||
before_script: | ||
- if [ "$TRAVIS_OS_NAME" = "osx" ]; then CMAKE_ARGS="-DCMAKE_PREFIX_PATH=/usr/local/opt/qt5"; fi | ||
- mkdir build && pushd build | ||
|
||
script: | ||
- cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUI_TESTS=ON $CMAKE_ARGS .. | ||
- make | ||
- cmake -DCMAKE_BUILD_TYPE=${CONFIG} -DWITH_GUI_TESTS=ON -DWITH_XC_HTTP=ON -DWITH_XC_AUTOTYPE=ON -DWITH_XC_YUBIKEY=ON $CMAKE_ARGS .. | ||
- make -j2 | ||
- if [ "$TRAVIS_OS_NAME" = "linux" ]; then make test ARGS+="-E testgui --output-on-failure"; fi | ||
- if [ "$TRAVIS_OS_NAME" = "linux" ]; then xvfb-run -a --server-args="-screen 0 800x600x24" make test ARGS+="-R testgui --output-on-failure"; fi | ||
- if [ "$TRAVIS_OS_NAME" = "osx" ]; then make test ARGS+="--output-on-failure"; fi | ||
|
||
# Generate snapcraft build when merging into master/develop branches | ||
#after_success: | ||
# - popd | ||
# - "[[ $DEPLOY = 1 ]] && [[ $CONFIG = Release ]] && [[ $TRAVIS_BRANCH =~ (master|develop) ]] && [[ $TRAVIS_PULL_REQUEST = false ]] \ | ||
# && docker run -v $(pwd):/cwd snapcore/snapcraft sh -c 'cd /cwd && apt update && snapcraft'" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
#!/usr/bin/env bash | ||
# | ||
# KeePassXC AppImage Recipe | ||
# Copyright (C) 2017 KeePassXC team <https://keepassxc.org/> | ||
# | ||
# This program is free software: you can redistribute it and/or modify | ||
# it under the terms of the GNU General Public License as published by | ||
# the Free Software Foundation, either version 2 or (at your option) | ||
# version 3 of the License. | ||
# | ||
# This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
# GNU General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU General Public License | ||
# along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
if [ "$1" == "" ] || [ "$2" == "" ]; then | ||
echo "Usage: $(basename $0) APP_NAME RELEASE_VERSION" >&2 | ||
exit 1 | ||
fi | ||
|
||
if [ -f CHANGELOG ]; then | ||
echo "This recipe must not be run from the sources root." >&2 | ||
exit 1 | ||
fi | ||
|
||
if [ ! -d ../bin-release ]; then | ||
echo "../bin-release does not exist." >&2 | ||
exit 1 | ||
fi | ||
|
||
APP="$1" | ||
LOWERAPP="$(echo "$APP" | tr '[:upper:]' '[:lower:]')" | ||
VERSION="$2" | ||
|
||
mkdir -p $APP.AppDir | ||
wget -q https://github.com/probonopd/AppImages/raw/master/functions.sh -O ./functions.sh | ||
. ./functions.sh | ||
|
||
cd $APP.AppDir | ||
cp -a ../../bin-release/* . | ||
mv ./usr/local/* ./usr | ||
rmdir ./usr/local | ||
patch_strings_in_file /usr/local ./ | ||
patch_strings_in_file /usr ./ | ||
|
||
get_apprun | ||
copy_deps | ||
delete_blacklisted | ||
|
||
get_desktop | ||
get_icon | ||
get_desktopintegration $LOWERAPP | ||
|
||
GLIBC_NEEDED=$(glibc_needed) | ||
|
||
cd .. | ||
|
||
generate_appimage | ||
|
||
mv ../out/*.AppImage .. | ||
rmdir ../out > /dev/null 2>&1 |
Oops, something went wrong.