~harvest-dev/harvest/trunk

248.1.7 by Daniel Holbach
make HACKING just a small text file that we reference to from the main page
1
HACKING Harvest
2
3
The code of harvest lives in Launchpad and makes use of Python and Django: 
4
5
	https://code.launchpad.net/harvest
6
7
8
Harvest regularly pulls data from URLs stored in the  opportunities  file in the  https://code.launchpad.net/harvest-data  branch. The file layout is pretty simple.
9
10
Before attempting to download the CSV (comma-separated values) file, Harvest will check the  Last-Modified  entry in the HTTP header and see if any modifications were made. This is done to reduce traffic.
11
12
13
Opportunities?
14
15
The  opportunities  file is in CSV and of the following format:
16
17
<url>(,<description>)(,<link to more documentation>)
18
19
The URLs to CSV files must be reachable via HTTP(s). The description and link to more documentation are optional.
20
21
The CSV file in turn needs to be of the following form:
22
<sourcepackage>,<url>,<description>
23
24
For example:
25
vdrift,http://launchpad.net/bugs/106854,106854
26
27
Opportunities can be anything:
28
 * Easy bugs
29
 * Suitable Upstream patches
30
 * Patches of other distributions
31
 * Problems in the CD builds that should be fixed
32
 * etc.
33
34
Let your imagination go wild. :-)
35
36
37
To get new opportunities included, please push a branch to Launchpad and ask for it to be merged into  harvest-data  trunk.
38
39
	https://help.launchpad.net/Code/UploadingABranch
40
	https://launchpad.net/harvest-data/trunk
41
42
43
Setting it up
44
45
Just
46
 * bzr branch lp:harvest
47
 * less harvest/INSTALL