From 0ef7358b510cbd97460ca9f82d54d8c7276f55ec Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Wed, 19 Apr 2017 14:11:32 +0200 Subject: Updated documentation --- CONTRIBUTING.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.md') 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. -- cgit v1.2.1