Add table of contents and intro to file HACKING

This commit is contained in:
Christian Dywan 2010-04-20 18:11:25 +02:00
parent 4321733fde
commit 1802d577b1

19
HACKING
View file

@ -1,6 +1,23 @@
This file is licensed under the terms of the expat license, see the file EXPAT. 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 Indentation is 4 spaces, no tabs, preferrably at 80 to 120 columns per line to
avoid automated line-breaks. Trailing whitespace is not desirable. avoid automated line-breaks. Trailing whitespace is not desirable.