diff options
author | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-12-14 15:41:33 +0100 |
---|---|---|
committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-12-14 15:41:33 +0100 |
commit | 6385450e7bf9e573da0c274e7a04ed816d9e7f6a (patch) | |
tree | f539f6b83777c3fce184d727b2e8db9eaba12262 /docs/manual/Contributing.Code.md | |
parent | Cleaned up UrlLineEdit (diff) | |
download | smolbote-6385450e7bf9e573da0c274e7a04ed816d9e7f6a.tar.xz |
Updated documentation
Diffstat (limited to 'docs/manual/Contributing.Code.md')
-rw-r--r-- | docs/manual/Contributing.Code.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/docs/manual/Contributing.Code.md b/docs/manual/Contributing.Code.md deleted file mode 100644 index d84e14f..0000000 --- a/docs/manual/Contributing.Code.md +++ /dev/null @@ -1,51 +0,0 @@ -# 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. |