This page:
Page history
Links to here

Last modified:
2009-02-11 at 00:20

Guidelines

Please read this page if you're contributing to the game, by writing patches, reporting bugs, or using the issue tracker.

For proposed changes:

  • feature / gameplay changes should be discussed on the forum / r.g.r.a first
  • code-level changes should be discussed in angband-dev or on IRC first

Tickets should:

  • have clear titles
  • include a link to relevant forum threads
  • have clear criteria for marking them as closed
  • be assigned to the milestone you intend to work on it by (for features), or the next milestone (for bugs)
  • be updated with any related commit numbers, by adding a comment with "in r425" or "partially in "r466" in it (eventually this will be automatic)

Patches should:

  • be attached to a relevant bug on the tracker, or sent to angband-dev
  • be in unified diff format and preferably be against SVN trunk ("svn diff") or the latest public release ("diff -u").
  • follow the CodingGuidelines

If the patch is a bugfix, then you can reasonably expect it to be integrated into the development tree pretty quickly. If it's more involved, and the feature is not one that the next version is planned to have, the patch may go through several reviews before being incorporated. It may also just be unsuitable for Angband—in which case, please don't take rejection badly; you may just be better off writing a variant.

Commits should:

  • compile
  • happen early and often
  • be as standalone as possible
  • have messages which reference bug numbers they relate to in parentheses at the front of the message, like "(#34) Imported new savefile code"