From f0551b8645d9e3babf35e40fbc74c02ec8990e58 Mon Sep 17 00:00:00 2001
From: Aqua-sama <aqua@iserlohn-fortress.net>
Date: Fri, 22 Sep 2017 16:44:19 +0200
Subject: Updated documentation

---
 docs/manual/Contributing.Code.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/manual/Contributing.Code.md

(limited to 'docs/manual/Contributing.Code.md')

diff --git a/docs/manual/Contributing.Code.md b/docs/manual/Contributing.Code.md
new file mode 100644
index 0000000..419a08c
--- /dev/null
+++ b/docs/manual/Contributing.Code.md
@@ -0,0 +1,35 @@
+# Before you submit
+
+## Licensing
+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})/
+```
+
+## 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.
-- 
cgit v1.2.1