summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorChristian Dywan <christian@twotoasts.de>2010-04-20 18:15:22 +0200
committerChristian Dywan <christian@twotoasts.de>2010-04-20 18:15:22 +0200
commite44b6beb7fc2249bb3731fd98c0a77af70fbda34 (patch)
tree879bc2a8b02be5e1454fcbd9f5f664a9edebd951 /HACKING
parentbd9dc251a177957a1da3d26cbf64348ce28c92f0 (diff)
downloadmidori-e44b6beb7fc2249bb3731fd98c0a77af70fbda34.tar.gz
Add table of contents and intro to file HACKING
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING19
1 files changed, 18 insertions, 1 deletions
diff --git a/HACKING b/HACKING
index 944dfa8a..3b35489b 100644
--- a/HACKING
+++ b/HACKING
@@ -1,6 +1,23 @@
This file is licensed under the terms of the expat license, see the file EXPAT.
-+++ Hacking guide for Midori +++
++ Hacking guide for Midori +
+
+- How to contribute
+- Coding style
+- Source files in the project
+- Examplary source code
+
++++ How to contribute +++
+
+There are several ways to contribute to the project:
+
+For translating, have a look at the file TRANSLATE.
+
+For helping with testing and triaging bug reports, you should registers with the bug tracker at http://www.twotoasts.de/bugs and join #midori on irc.freenode.net where a lot of problems are discussed. You can start right away by trying to reproduce bug reports and comment with your findings.
+
+If you are interested in contributing code, there are a few options. You can join #midori to discuss a particular problem you would like to look into, or a feature you would want to implement. Opening a bug report or feature request if there isn't already one is the next step. To attract some attention, if you attached a patch or have questions, ask in #midori.
+
++++ Coding style +++
Indentation is 4 spaces, no tabs, preferrably at 80 to 120 columns per line to
avoid automated line-breaks. Trailing whitespace is not desirable.