| | 1 | = A. Before you file a ticket .... = |
| | 2 | |
| | 3 | == 1. Check the Hot Problems list == |
| | 4 | |
| | 5 | The Hot Problems list contains possible solutions to problems that affect many MacPorts users. If a solution to your problem is listed, don't file a ticket. |
| | 6 | |
| | 7 | == 2. Search to see if a Trac ticket has already been filed. == |
| | 8 | |
| | 9 | Avoid filing duplicate bugs. |
| | 10 | |
| | 11 | == 3. Is the problem an application error and not related to compiling and installing? == |
| | 12 | |
| | 13 | In general, application bugs should be reported to the developers of the app ("upstream"), not MacPorts. An application bug that affects a large number of MacPorts users might merit a MacPorts bug for informational purposes only, but this should be done sparingly. |
| | 14 | |
| | 15 | == 4. Is the problem with a 'port upgrade' operation? == |
| | 16 | |
| | 17 | If so, try a 'port uninstall foo' and then reinstall. You might also want to run 'port -fR upgrade foo' to rebuild ports depending upon port foo. |
| | 18 | |
| | 19 | = B. How to file a ticket = |
| | 20 | |
| | 21 | Filing tickets with proper form is important. Here are the most important elements. |
| | 22 | |
| | 23 | == Short summary: == |
| | 24 | |
| | 25 | 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. |
| | 26 | |
| | 27 | '''1st part:''' ''''' BUG: ''''' or ''''' RFE: ''''' prefix |
| | 28 | |
| | 29 | * "BUG:" A problem - a port is not installing functioning as intended. |
| | 30 | * "RFE:" A request for enhancement - updates, new ports, or suggestions for how you'd like a port modified. |
| | 31 | |
| | 32 | '''2nd part:''' '''''-xx.xx.xx''''': versions change frequently so list the version! |
| | 33 | |
| | 34 | Examples for port tickets. |
| | 35 | |
| | 36 | * BUG: emacs-21.4a build failure on Intel |
| | 37 | * BUG: p5-perlmagick-6.29 configure error - freetype not found |
| | 38 | * RFE: gowidget-0.2.5 add a no_x11 variant |
| | 39 | * RFE: defender-0.1.1 alien invader support is off -enble alien invaders |
| | 40 | |
| | 41 | Examples for Base (MacPorts infrastructure) tickets. |
| | 42 | |
| | 43 | * BUG: base-1.3.0 quits unexpectedly sometimes during 'port install' |
| | 44 | * BUG: base-1.3.2 'port search foo' doesn't find foox, fooy, etc |
| | 45 | * RFE: base-1.3.2 add a Portfile keyword to chop onions |
| | 46 | |
| | 47 | == Assign to: == |
| | 48 | Select the maintainer of the port as listed in the Portfile 'maintainers' keyword. If the maintainer is not on the list, place his/her email address in the Cc: field so they will be notified. |
| | 49 | |
| | 50 | == Type: == |
| | 51 | * BUG's = "defects" |
| | 52 | * RFE's = "enhancements" |
| | 53 | |
| | 54 | == Version: == |
| | 55 | Select the MacPorts version you are using. |
| | 56 | |
| | 57 | == Cc: == |
| | 58 | Enter the email address of those you wish to be cc a copy of the ticket. |
| | 59 | |
| | 60 | == Component: == |
| | 61 | Select "ports" or "base" to match the summary line. |
