[[PageOutline(2-5,Contents,pullout)]] = Adds custom fields for Story Point Estimates == Description This is a plugin that adds custom fields for '''Story Point Estimates''', '''Ticket Completed Date''' and '''User Story Keyword''' field. It also disables Reports in favor of custom ticket queries, so tickets can be viewed to include the custom fields. Lastly, it provides a set of additional ticket query wiki macros that allow you to aggregate and report on Story Point totals. Use this plugin for tracking tasks that need to be estimated in Story Points. A story point is an arbitrary measure used by Scrum teams. It is used to measure the effort required to implement a story. In simple terms it is a number that tells the team how hard the story is. It is related to the concept of [wikipedia:Function_point function points]. == Bugs/Feature Requests Existing bugs and feature requests for TracStoryPointsPlugin are [report:9?COMPONENT=TracStoryPointsPlugin here]. If you have any issues, create a [/newticket?component=TracStoryPointsPlugin new ticket]. [[TicketQuery(component=TracStoryPointsPlugin&group=type,format=progress)]] == Download Download the zipped source from [export:tracstorypointsplugin here]. == Source You can check out TracStoryPointsPlugin from [/svn/tracstorypointsplugin here] using Subversion, or [source:tracstorypointsplugin browse the source] with Trac. == Installation See installation notes in the copied README file below. == Recent Changes [[ChangeLog(tracstorypointsplugin, 3)]] == Author/Contributors '''Author:''' [wiki:Streamweaver] [[BR]] '''Maintainer:''' [[Maintainer]] [[BR]] '''Contributors:''' == General Documentation From the README.TXT This plug-in aims to provide some very simple support for story point estimation and tracking. This plug-in adds the following fields to Trac Tickets by adding them to the trac.ini file for the site. '''ADDITIONAL TICKET FIELDS''' Storypoints - Drop-down field listing story point values. The values used [[BR]] can be customized in the sites trac.ini file if needed. [[BR]] field name: storypoints Date Completed - A text field to enter the date a ticked is completed. [[BR]] Format must be mm/dd/YYYY. See notes below for adding [[BR]] a plug-in for a calander widget to this field. [[BR]] fieldname: completed User Story - A text field to enter in a keyword to associate this with a particular user story. fieldname: userstory '''CHANGES TO TRAC REPORTS''' This plug-in deactivates the legacy trac reports system in favor of the new ticket query system. This allows custom querying of tickets and ticket fields so the additional ticket fields can be easily displayed. See TracReports for more Information on Trac Reports versus Trac Query module. '''IMPROVED TRAC TICKET QUERY WIKI MACROS''' This plug-in provides improved Trac Ticket Query Wiki Macros as well as additional formats for the query. It it important to understand this behaves just like normal Track Ticket Queries with some additional options. For More information on Trac Ticket Query Wiki Macros see TracQuery. To use the expanded TICKET QUERY macros use SpTicketQuery instead of TickeyQuery ADDITIONAL FEATURES OF SpTicketQuery In standard TicketQuery macros you can add additional column to table format by specifying a col attribute. This plug-in extends that to list format as well, appending additional fields as annotations at the end of the summary. For example: {{{ [[SpTicketQuery(milestone=User Dashboard, format=list,col=id|summary|storypoints|completed)]] }}} SpTicketQuery also provides several new formats for the ticket query, related to story point reporting. These additional formats are: * format=total - Returns the total story points for all tickets in the query. * format=completed - Returns the total story points of all closed tickets in a query. * format=remaining - Returns the total story points of all non-closed tickets in a query. * format=storypoints - Returns a string summarizing total, completed and remaining story [[BR]] points for all tickets in a query. [[BR]] example: 16.0 Total Story Points with 13.0 Completed and 3.0 Remaining. '''INSTALLATION''' Trac plug-ins are installed as python eggs and this plugin requires no special installation. See TracPlugins for more information. In a nutshell just upload and activate the python egg via your trac sites admin > plugins page. Alternatively running easy_install on the egg file to install the plugin and make it available for all sites in a trac multi- site installation. If you are installing from source just checkout the source and run 'python setup.py bdist_egg' to create an egg file. You can locate the resulting egg file from the output of the bdist buffer. '''UNINSTALLING''' Deactivate the plug-in in the admin section for your individual site. Then modify site site trac.ini file to remove custom fields added by the plug-in under the [ticket-custom] section. The lines to remove should look something like this: completed = text [[BR]] completed.label = Date Completed [[BR]] completed.order = 9110 [[BR]] storypoints = select [[BR]] [[BR]] storypoints.label = Storypoints [[BR]] storypoints.options = |0|0.5|1|2|3|5|8|13|21|34|55 [[BR]] storypoints.order = 9100 [[BR]] userstory = text [[BR]] userstory.label = User Story [[BR]] userstory.order = 9120 [[BR]] '''OTHER PLUGINS OF POSSIBLE INTEREST''' DateFieldPlugin Provides a convenient javascript calendar widget that lets you select dates for fields in trac. This can be convenient for use in the completed date filed of trac tickets using the TracStoryPoint plugin. To configure this for use install it as usual and add the following lines to your sites trac.ini file: [calendarpopup] [[BR]] ids=field-completed=MM/dd/yyyy [[BR]] files=ticket.html