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