aboutsummaryrefslogtreecommitdiff
path: root/docs/manual
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2017-12-13 13:43:41 +0100
committerAqua-sama <aqua@iserlohn-fortress.net>2017-12-13 13:43:41 +0100
commit7078da9ea8feef6fc89151e9359e9e9ae3bb5724 (patch)
tree1780dc70b661ae3e3681b738e2c5e7b225d26c98 /docs/manual
parentAutogenerating settings dialog (diff)
downloadsmolbote-7078da9ea8feef6fc89151e9359e9e9ae3bb5724.tar.xz
Updated documentation
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/Contributing.Code.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/manual/Contributing.Code.md b/docs/manual/Contributing.Code.md
index 419a08c..d84e14f 100644
--- a/docs/manual/Contributing.Code.md
+++ b/docs/manual/Contributing.Code.md
@@ -4,14 +4,30 @@
Smolbote is licensed under GPLv3. Your code needs to be compatible with it, and
have a license header.
-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})/
```
+```c
+/******************************************************************************
+ **
+ ** smolbote: yet another qute browser
+ **
+ ** Copyright (C) 2017 author <email>
+ ** SPDX-License-Identifier: GPL-3.0
+ ** License-Filename: docs/gpl-3.0.md
+ **
+ ******************************************************************************/
+```
+
+### SPDX-License-Identifier
+A full list of license identifiers can be found on [the SPDX website](https://spdx.org/licenses/).
+
+### License-Filename
+Path to the license text, relative to the repository root.
+
## Style
Please use the [One True Brace style](https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS_.28OTBS.29).
Tabs are 4 spaces.