blob: f9869de2b34e9fc2d993af9ff4cdad4c24fc8aad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
## Reporting
### Reporting bugs
Please include the following when reporting bugs:
* Operating system used
* Version of Qt used
* Detailed explanation of the bug:
* what was done
* what was expected
* what happened
## Contributing
### Hooks
Symlink the hooks:
```
[smolbote repo]$ ln -s ../../tools/hooks/pre-commit.rb .git/hooks/pre-commit
```
### Code
* Where possible, use QVector over QList:
http://lists.qt-project.org/pipermail/development/2017-March/029040.html
### 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.
### Branching
* master - main branch, should be kept up-to-date, and have only working code
* development - development branch, anything goes there
### Folder structure
folder | description
------ | -----------
/src | source code
/src/widgets | subclassed Qt widgets
/src/forms | Qt UI forms and classes
/src/webengine | QWebEngine* subclasses
/test | test run location, mainly for QtCreator
### Licensing
Please include an appropriate license header in any file you add. A sample GPLv3
header is included in docs/header-gpl3.txt.
The provided pre-commit hook uses the following regular expression to check for
a license:
```ruby
/Copyright\s\(C\)\s(\d{4}\s*-\s*){0,1}(#{Time.now.year})/
```
### QtCreator
* In the project Run Settings set the working directory to _$repo/test_, and the
command line arguments to _-c poi.conf_.
### firejail
Any submitted modifications should work with the provided firejail profile.
### clazy
You can use [clazy](clazy-git) to check Qt semantics. Requires clang.
To easily set check levels, set the CLAZY_CHECKS environment variable to
'level0,level1', etc.
[clazy-git]: https://github.com/KDE/clazy
|