Changes between Version 1 and Version 2 of KeywordGuide

07/12/09 15:00:04 (11 years ago)

Second save - first full version


  • KeywordGuide

    v1 v2  
    1 == Using keywords in tickets == 
     1= Using keywords in tickets = 
    33Angband is a big program. There are many thousand lines of code, and dozens of different things to consider when working on it. With a few exceptions (like the maintainer), most developers are interested in specific aspects of the code (user interface, item generation, vaults, savefile handling, whatever). Using keywords in your tickets helps them find the tickets they're interested in more easily, and makes it more likely that your ticket will receive attention. 
    77Keywords should always be used in lower case, and each keyword should be separated by a single space. (Please do not use multiple keywords unless they're all relevant - if you can separate the issues, consider opening multiple tickets instead. There is no pressure to minimise the number of tickets.) 
    9 = Platform- and port-specific keywords = 
     9If you want to search for tickets with specific keywords, go to View Tickets and then click Custom Query, and add a filter by keyword. 
     11== Platform- and port-specific keywords == 
    1012 * windows --  if your issue only happens in Windows, please use this keyword. (If you don't know whether it only happens in windows, that's fair enough - someone will add the keyword later when this has been established.) Please do NOT use any other keywords for Windows-related issues (e.g. vista, win7, xp-64 etc.) - if you believe that your issue is related to some specific version of Windows, please state this in the ticket description. 
    1113 * unix --  as above, but for Unix-specific issues (e.g. setgid, FHS, X problems etc.). As with Windows, please do not use specific Unices or Linux distributions as keywords, with one exception: please use the keyword "debian" for issues specific to building the .deb, or converting it to some other package format (e.g. RPM). 
    2123Please do not use any of the above keywords unless you are fairly sure that your issue is specific to that platform or port. 
    23 = Coding style and compatibility keywords = 
     25== Coding style and compatibility keywords == 
    2426 * cleanup --  for tickets about cleaning or improving sections of code ''without'' changing their effect 
    2527 * compat --  for issues such as compiler warnings, C89 compatibility, autotools issues etc. 
    2628 * doc --  for issues about documenting the code (c.f. "help" below) 
     29 * patch --  if your ticket has a patch attached 
     30 * gpl --  for licensing issues 
    28 = Gameplay keywords = 
    29  * squelch --  if your ticket is about squelching or unsquelching 
    30  * knowledge --  for issues relating to the knowledge menu 
     32== Gameplay keywords == 
     33 * birth --  for issues related to starting the game (not starting the program) 
     34 * items --  for issues about item generation and monster drops (Too Much Junk, Not Enough Stat Potions, Rubbish Randarts, Boring Curses etc.) 
     35 * spells --  for spell-related issues including mana and casting, plus activations and spell-like item effects 
    3136 * stores --  for anything related to the stores, including the home 
    3237 * ai --  for monster behaviour 
     38 * detection --  for issues about detection, panel-flipping, ESP etc.  
     39 * dungeon --  for level generation, level feelings, vaults etc. 
     40 * player --  for issues relating to the mechanics of stats, resists, classes, food, stealth, timed effects etc. 
     41 * combat 
     42 * traps 
     43 * id 
     45== Metagame keywords == 
     46 * help --  for issues related to game documentation, tutorial etc. 
     47 * knowledge --  for issues relating to the knowledge menu 
    3348 * wizmode --  for anything that happens in wizard mode 
    35 = Metagame keywords = 
    36  * (save) 
     49 * recall --  for issues about monster and object recall or descriptions 
     50 * squelch --  if your ticket is about squelching or unsquelching 
     52== User interface keywords == 
     53 * ui --  for general user interface issues (deprecated in favour of anything more specific) 
     54 * graphics --  for general graphics/tile issues which are not port-specific 
     55 * mouse --  as above 
     56 * sound --  as above 
     57 * subwindows --  for issues about the content, function and updating of subwindows (which are not port-specific) 
     58 * loadsave --  for loading and saving issues 
     59 * macros 
     60 * inscriptions