aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/Contributing.Submitting.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual/Contributing.Submitting.md')
-rw-r--r--docs/manual/Contributing.Submitting.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/manual/Contributing.Submitting.md b/docs/manual/Contributing.Submitting.md
new file mode 100644
index 0000000..d84e14f
--- /dev/null
+++ b/docs/manual/Contributing.Submitting.md
@@ -0,0 +1,51 @@
+# Before you submit
+
+## Licensing
+Smolbote is licensed under GPLv3. Your code needs to be compatible with it, and
+have a license header.
+
+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.
+
+For ease of use, you can set the following astyle configuration:
+```
+--style=otbs
+--attach-namespaces
+--attach-inlines
+--indent=spaces=4
+```
+
+## Format patch for email
+```sh
+git format-patch hash
+```
+where _hash_ is the commit immediately prior to the commit or series of commits
+you want to submit.
+
+Attach the patch file and email it to _aqua at iserlohn-fortress.net_. If
+possible, GPG sign the email.