diff options
author | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-04-19 14:11:32 +0200 |
---|---|---|
committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-04-19 14:11:32 +0200 |
commit | 0ef7358b510cbd97460ca9f82d54d8c7276f55ec (patch) | |
tree | 3f244b8d44caa3cac146a5038026a633d18afeee /CONTRIBUTING.md | |
parent | Address bar menu and search (diff) | |
download | smolbote-0ef7358b510cbd97460ca9f82d54d8c7276f55ec.tar.xz |
Updated documentation
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d99985..03e0879 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,11 +47,18 @@ Major bugfixes and each new feature should get a revision. /test | test run location, mainly for QtCreator ### Licensing -Please include an appropriate license header in any file you add. +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 ./config.ini_. +command line arguments to _-c poi.conf_. ### firejail -Any submitted modifications must work with the provided firejail profile. +Any submitted modifications should work with the provided firejail profile. |