ChangeLog.README

   1 darcs uses an automated ChangeLog generation system.
   2
   3 To generate the ChangeLog use: make ChangeLog
   4
   5 Contributing changelog messages is one of the ways that non-haskell persons
   6 can contribute to darcs development.  If you would like to add a new entry
   7 to the ChangeLog, just follow these instructions:
   8
   9 1) Create a new file in the directory changelog.in/entries/.  You may
  10    either name this file after yourself, or after the change you'd like to
  11    document.  Note that there can be many entries in a single file, but by
  12    convention you shouldn't add entries to files named after other people,
  13    so that we can avoid conflicts (which was a major concern in designing
  14    this system).
  15
  16 2) Put in this file one or more "match:" statements describing one or more
  17    patches that implement the change.  See below (or look at other files in
  18    the entries/ directory) for an example demonstrating the format.
  19
  20 3) After the "match" statements, put the actual change comment, with each
  21    line preceded by "> " as if it were a quote in an email.  The comment
  22    will be automatically indented and line wrapped, and the "*" added,
  23    so just add the human-readable information.  It is conventional to place
  24    attribution of whoever did the actual coding at the end of the message.
  25
  26 It's that easy! Rerun make ChangeLog to see your beautiful creation.
  27
  28 EXAMPLE ENTRY:
  29
  30 match: name "Add .query manifest. command"
  31
  32 > Add new "query manifest" command to list files and/or directories in
  33 > repository.  Add some related infrastucture to support
  34 > "subcommands". (Florian Weimer)
  35
  36 If you want to edit an existing entry, you'll have to grep through the
  37 contents of changelog.in/entries/ to find the file where that entry is
  38 located, where you can edit it.
  39
  40 To submit your contribution, you add the new file and run darcs record,
  41 making sure to include the phrase "changelog entry" or "changelog entries"
  42 in the patch name, and then use darcs send to email the patch to
  43 darcs-devel@darcs.net.