HACKING

   1
   2 Conventions?  Are you kidding?  OK fine.
   3
   4 Code Branching Model
   5 ====================
   6
   7 The master branch is what we consider the main-line of development,
   8 and the last, non-rc tag on master is the most recent stable release.
   9
  10 Of course, in all fairness, it has been a *long* time since the last
  11 stable release, but we're working fairly hard to fix that -- no,
  12 seriously.
  13
  14 Any branch with a "tmp/" prefix might be rebased (often), so keep that
  15 in mind when using or depending on one.
  16
  17 Any branch with a "tmp/review/" prefix corresponds to a patchset
  18 submitted to the mailing list.  We try to maintain these branches to
  19 make the review process easier for those not as familiar with patches
  20 via email.
  21
  22
  23 Current Trajectory
  24 ==================
  25
  26 At the moment, the primary goal is to test master in preparation for a
  27 0.25 release, which among many other things will include more complete
  28 support for filesystem metadata.
  29
  30 If you have the time and inclination, please help review patches
  31 posted to the list for inclusion in 0.25.  (See "ways to help" below.)
  32
  33 We'd like to try to release (0.25) soon, so we're limiting the scope
  34 of prospective changes -- definitely in-scope:
  35
  36   - fixes to the new metadata support
  37   - fixes for regressions (portability included)
  38   - fixes for "serious" bugs
  39   - "simple" fixes
  40   - documentation improvements
  41
  42
  43 More specific ways to help
  44 ==========================
  45
  46 Testing -- yes please.
  47
  48 With respect to patches, bup development is handled via the mailing
  49 list, and all patches should be sent to the list for review (see
  50 "Submitting Patches" below).
  51
  52 In most cases, we try to wait until we have at least one or two
  53 "Reviewed-by:" replies to a patch posted to the list before
  54 incorporating it into master, so reviews are an important way to help.
  55 We also love a good "Tested-by:" -- the more the merrier.
  56
  57
  58 Submitting patches
  59 ==================
  60
  61 As mentioned, all patches should be posted to the mailing list for
  62 review.
  63
  64 You can create a "signed off" (see ./SIGNED-OFF-BY) set of patches in
  65 ./pending, ready for submission to the list, like this:
  66
  67     git format-patch -s -o patches origin/master
  68
  69 which will include all of the patches since origin/master on your
  70 current branch.  Then you can send them to the list like this:
  71
  72     git send-email --to bup-list@googlegroups.com --compose patches/*
  73
  74 The use of --compose will cause git to ask you to edit a cover letter
  75 that will be sent as the first message.
  76
  77 It's also possible to handle everything in one step:
  78
  79     git send-email -s --to bup-list@googlegroups.com --compose origin/master
  80
  81 and you can add --annotate if you'd like to review or edit each patch
  82 before it's sent.
  83
  84 For single patches, this might be easier:
  85
  86     git send-email -s --to bup-list@googlegroups.com --annotate -n1 HEAD
  87
  88 which will send the top patch on the current branch, and will stop to
  89 allow you to add comments.  You can add comments to the section with
  90 the diffstat without affecting the commit message.
  91
  92 Of course, unless your machine is set up to handle outgoing mail
  93 locally, you may need to configure git to be able to send mail.  See
  94 git-send-email(1) for further details.
  95
  96 Oh, and we do have a ./CODING-STYLE, hobgoblins and all, though don't
  97 let that scare you off.  We're not all that fierce.
  98
  99
 100 Even More Generally
 101 ===================
 102
 103 It's not like we have a lot of hard and fast rules, but some of the
 104 ideas here aren't altogether terrible:
 105
 106   http://www.kernel.org/doc/Documentation/SubmittingPatches
 107
 108 In particular, we've been paying at least some attention to the bits
 109 regarding Acked-by:, Reported-by:, Tested-by: and Reviewed-by:.