| 27 | | Filing tickets with the proper form is important. Here are the most important elements. |
| 28 | | |
| 29 | | == Short summary: == |
| 30 | | |
| 31 | | This is the most important part. Don't force people to open the ticket to try to determine whether it is a BUG or RFE, the port version, or get a good idea what the ticket is about. |
| 32 | | |
| 33 | | '''1st summary part:''' ''''' BUG: ''''' / '''''UPDATE: ''''' / '''''NEW: ''''' / ''''' RFE: ''''' — summary line prefix. |
| 34 | | |
| 35 | | * "BUG:" A problem - a port is not installing functioning as intended. |
| 36 | | * "UPDATE:" A port update patch submission |
| 37 | | * "NEW:" A new port submission |
| 38 | | * "RFE:" A request for enhancement - updates, new ports, or suggestions for how you'd like a port modified. |
| 39 | | |
| 40 | | '''2nd summary part:''' '''''-xx.xx.xx''''' — versions change frequently so list the version! |
| 41 | | |
| 42 | | '''3rd summary part:''' ''Concise description'' — if a BUG or RFE. |
| 43 | | |
| 44 | | Examples for port tickets. |
| 45 | | |
| 46 | | * BUG: emacs-21.4a build failure on Intel |
| 47 | | * BUG: p5-perlmagick-6.29 configure error - freetype not found |
| 48 | | * UPDATE: fishtail-0.93 -> 0.99 |
| 49 | | * NEW: bettyboop-1.2.7 |
| 50 | | * RFE: foofah - new port request |
| 51 | | * RFE: gowidget-0.2.5 add a no_x11 variant |
| 52 | | * RFE: defender-0.1.1 alien invader support is off -enable alien invaders |
| 53 | | |
| 54 | | Examples for Base (MacPorts infrastructure) tickets. |
| 55 | | |
| 56 | | * BUG: base-1.3.0 quits randomly sometimes during 'port install' |
| 57 | | * BUG: base-1.3.2 'port search foo' doesn't find foox, fooy, etc |
| 58 | | * RFE: base-1.3.2 add a Portfile keyword to chop onions |
| 59 | | |
| 60 | | == Assign to: == |
| 61 | | Select the maintainer's email address; see "port info <portname>". If the maintainer's email address is not in the list, or if the maintainer is "nomaintainer@macports.org", select "macports-dev@lists.macosforge.org". |
| 62 | | |
| 63 | | == Type: == |
| 64 | | * BUGs = "defects" |
| 65 | | * RFEs = "requests for enhancement" |
| 66 | | |
| 67 | | == Version: == |
| 68 | | Select the MacPorts version you are using. |
| 69 | | |
| 70 | | == Cc: == |
| 71 | | Enter the maintainer's email address; see "port info <portname>". This ensures that the maintainer will receive an email about the new ticket and any changes that are made to it. This is important, because Trac currently only sends emails to addresses on the Cc list, not to the reporter or the assignee. (Trac is capable of sending such emails, but this is currently disabled on the MacPorts server, and unfortunately we neither maintain the server, nor have yet been able to persuade the actual maintainers to change this.) Skip this step if the maintainer is "nomaintainer@macports.org". |
| 72 | | |
| 73 | | Please also enter your email address so that you will be notified when changes are made to the ticket. The person handling the ticket may need to ask you follow-up questions, and will probably do so by writing in the ticket. |
| 74 | | |
| 75 | | == Component: == |
| 76 | | Select "ports" or "base" to match the summary line. |
| 77 | | |
| 78 | | == Attachments: == |
| 79 | | If you have files (such as patches) to attach to the ticket, fill out the rest of the ticket first and submit it. You'll have the chance to add an attachment next. |
