diff options
Diffstat (limited to 'docs/manual/Contributing.Style.md')
| -rw-r--r-- | docs/manual/Contributing.Style.md | 28 |
1 files changed, 6 insertions, 22 deletions
diff --git a/docs/manual/Contributing.Style.md b/docs/manual/Contributing.Style.md index 1ab6b17..4d7ef1b 100644 --- a/docs/manual/Contributing.Style.md +++ b/docs/manual/Contributing.Style.md @@ -2,37 +2,21 @@ ## Guidelines * Use generic formats -* Where possible, use QVector over QList: -http://lists.qt-project.org/pipermail/development/2017-March/029040.html +* Where possible, use QVector over QList: http://lists.qt-project.org/pipermail/development/2017-March +/029040.html +* Check pointers with Q_CHECK_PTR before returning them ## Versioning -#### Major version -Changed infrequently and almost entirely out of foppery and whim. - -#### Minor version -Milestone of multiple features. - -#### Revision -Major bugfixes and each new feature should get a revision. +- major version: Changed infrequently and almost entirely out of foppery and whim. +- minor version: Milestone of multiple features. +- revision: Major bugfixes and each new feature should get a revision. ### Branching * master - main branch, should be kept up-to-date, and have only working code * next - next stable release preparation, mostly for bugfixes * development - development branch, anything goes there -### Folder structure - - folder | description - ------ | ----------- -/src | source code -/src/widgets | subclassed Qt widgets -/src/formats | file format parsing (toml, xbel) -/src/forms | Qt UI forms and classes -/src/webengine | QWebEngine subclasses -/test | test run location, mainly for QtCreator - - ## clazy You can use [clazy](https://github.com/KDE/clazy) to check Qt semantics. Requires clang. |