## 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 ../../util/pre-commit.sh .git/hooks/pre-commit
```

### 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.

### QtCreator
* In the project Run Settings set the working directory to _$repo/test_, and the
command line arguments to _-c ./config.ini_.

### firejail
Any submitted modifications must work with the provided firejail profile.