Merge commit 'tuncer/for-jesper'
[etorrent.git] / HACKING
blob65bdf532e8eac865d269b6f81fc89c53638d3054
1 So you want to hack etorrent? Cool!
3 I am generally liberal, but there is one thing you should not do:
5 Patch Bombs.
7 A patch bomb is when a developer sits in his own corner for 4-5 months
8 and suddenly comes by with a patch of gargantuan size, say several
9 thousand lines of code changes. I won't accept such a patch - ever.
11 If you have a cool plan, I encourage you to mail me:
12 jesper.louis.andersen@gmail.com so we can set up a proper mailing list
13 and document our design discussions in the list archives. That way, we
14 may be able to break the problem into smaller pieces and we may get a
15 better solution by discussing it beforehand.
17 If you have a bug-fix or smaller patch it is ok to just come with it,
18 preferably on google code as a regular patch(1) or a git-patch. If you
19 know it is going to take you a considerable amount of time fixing the
20 problem, submit an issue first and then hack away. That way, others
21 may be able to chime in and comment on the problem.
23 Remember to add yourself to the AUTHORS list.
25 From 0.9 and on, we will have a ChangeLog describing user-visible
26 changes, ie features and bug fixes. I won't start it up before as the
27 code has been on a mad roller-coaster.
29 "I just want to hack, what is there to do?"
31 Check the TODO-list which is the loose milestone plan. Check the Issue
32 tracker for enhancement requests and bugs. Ask me. I might have
33 something you would like to do. The TODO list are "Things we certainly
34 need to do!" and the issue tracker is used for "Things we may do."
35 Note that people can vote up stuff on the issue tracker.