[Developers] Committing to /cactusdevcvs

Steve White swhite at aei.mpg.de
Fri Apr 15 08:48:03 CDT 2005

Here is a set of guidelines circulated in June 2003 concerning
commit policies.

Steve White : Programmer
Max-Planck-Institut für Gravitationsphysik      Albert-Einstein-Institut
Am Mühlenberg 1, D-14476 Golm, Germany                  +49-331-567-7625
-------------- next part --------------
From allen at aei.mpg.de Mon Jun 23 18:40:03 2003
Date: Wed, 11 Jun 2003 12:51:03 +0200 (CEST)
From: Gabrielle Allen <allen at aei.mpg.de>
To: Denis Pollney <pollney at aei.mpg.de>, Ian Hawke <hawke at aei.mpg.de>,
     Jonathan Thornburg <jthorn at aei.mpg.de>,
     Erik Schnetter <schnetter at tat.physik.uni-tuebingen.de>
Cc: Tom Goodale <goodale at aei.mpg.de>, Gabrielle Allen <allen at aei.mpg.de>,
     Thomas 'Bell' Radke <tradke at aei.mpg.de>,
     David Rideout <rideout at aei.mpg.de>, Ed Seidel <eseidel at aei.mpg.de>
Subject: Committing to /cactusdevcvs ...

As promised or threatened, here are the abridged guidelines from me, Tom 
and Thomas which we try to follow when developing core cactus stuff. It 
would be good if you could mail me back to say that you have read these 
or that you have an issue with something there. 

(BTW we scrapped the idea of a quick 4.0 release this week that I think I 
hinted in the last mail since we need to rework LocalInterp first)




Quick guide for commiting fixes/features to the Flesh and/or core Thorns
in the development cvs.cactuscode.org:/cactusdevcvs repository.

(core thorns are CactusBase, CactusBench, CactusConnect, CactusEinstein,
CactusElliptic, CactusExamples, CactusExternal, CactusIO, CactusPUGH, 
CactusPUGHIO, CactusTest, CactusUtils, CactusWave)

- Before starting your changes to the Flesh and/or core Thorns send an 
  email to e.g. developers at cactuscode.org, flesh at cactuscode.org or
  cactusmaint at cactuscode.org as appropropriate outlining what you are
  planning to do. If it is a largish thing send a initial spec for it at 
  the same time or as you start working on it.

- It is assumed that if you add something you will then be the primary
  person responsible for providing any needed bug fixes and or fielding 
  feature requests.

- Note that where possible functionality should be implemented in thorns, 
  avoiding APIs, features, parameters etc to the Flesh.

- If you add a change which will require users to rebuild their cactus
  configurations touch the file lib/make/force-rebuild and commit it.

- If you add a change which will require users to reconfigure their
  cactus configurations send a mail to developers at cactuscode.org to 
  inform people of this fact. (In principle all people using the 
  development version should be on this list). If you make a major
  or interesting change it is also good to email developers.

- Read and respect where possible the Maintainers Guide. In particular
    o always use standards (e.g. strictly ANSI C, posix and as strict as 
      makes sense F77/F90)
    o code in the same style as the existing source code
    o don't change parameters, function names or functionality without
      discussing first on mailing lists
    o be very confident that all the testsuites for all the core Thorns
      will still pass w/wo MPI on all the major architectures (even if you
      think you are just changing a comment at least run the testsuites
      for a good set of thorns on a machine)
    o make at most one feature change in each commit to make changes easy 
      to track (and try to keep cosmetic changes separate from functional 
    o give a descriptive commit message and remember that this is seen 
      publicly and archived
    o add or update grdoc in the source code
    o add and/or update documentation (Users Guide, FAQ, etc)
      [if the change is experimental and not for general use then
       don't add to the main documentation but document elsewhere]

- Update open bug reports or feature requests in the GNATs database
  if they are affected by these changes. 

- All additions to Flesh and core Thorns are with the distribution 
  license already documented in those places (with the current exception 
  of parts of CactusBase/LocalInterp and CactusTest/TestInterp)

- Copyright is with code authors



  Gabrielle Allen
  Max-Planck-Institut fuer Gravitationsphysik
  Albert Einstein Institut
  Am Muehlenberg 5, D-14476 Golm, Germany
  Email: gabrielle.allen at aei.mpg.de
  Phone:  +49 331 2003221 (or 56770)
  Mobile: +49 173 6194772             
  Fax:    +49 331 5677298             


More information about the Developers mailing list