TXM forge principles and procedures¶

Tickets Creation¶

General principles are described in the txm-info wiki: https://groupes.renater.fr/wiki/txm-info/public/transition_wiki_tickets

Ticket description and txm-info wiki page complementary description¶

If a txm-info wiki page is created to put more details about the ticket, the description must contain a direct link to that page. Use the @page_name syntax to refer to the page.

Squelette de page :

====== Titre ======

===== Objectif =====

===== Méthode =====
Description de la méthode de travail pour atteindre l'objectif
==== État de la plateforme ====
==== Avancement dans l'élaboration de la solution ====
===== Solution =====
==== État de l'art ====
Éléments de solution
==== Prototypes ====
==== Version finale ====
===== Recette =====
==== Protocole de test ====
=== Alpha ===
=== Beta ===
==== État courant ====
Qui Quand Quoi

Ticket categories definitions¶

Available ticket categories:

• Development : development tasks
• Administration: portal administration interface and tools (Portal project)
• Commands: any command related issue (all projects)
• Conventions: algorithms and terminology conventions (all projects)
• Documentation: any documentation issue (manuals, wikis, web pages...) (SH: Javadoc?)
• Import: any import module issue
• Preferences: RCP preferences issues
• Setup: desktop RCP setup issues
• Stats: statistic models issues
  • Stats / R: R related statistic models issues
• Toolbox: any issue related to the Toolbox project
• UI: User Interface issues in the RCP project (SH: and GWT project?)
  • UI / Interaction: user interface behavior issues
  • UI / Link / Command: user interface hypertextual command behavior issues

Ticket hierarchy policy¶

There are 2 usages:

• Grouping tasks
• Phasing tasks: children are steps and are ordered

Ticket life cycle¶

Ticket status follow this cycle:

New -> In Progress -> Resolved -> Feedback -> Closed

• New: the ticket concerns a demand not yet handled
• In Progress: the demand is currently being handled
• Resolved: : the solution is developed
• Feedback: tested during the Alpha step by the other users and developers.
• Closed: the solution is approved and is deployed throughout Beta Step.

Other status that can occur at any time in the development:

• Rejected: the demand is not to be handled

Ticket percent follow this cycle:

• 0-79: the ticket is being handled by the developer or has been downgraded by the tester from the 80 status
• 80: the ticket has been implemented and is proposed to be tested by someone else
• 90: the ticket has been validated on "test" portal
• 100: the ticket has been validated on production portal = the ticket is closed

Warning: parent tickets don't follow that policy (percent is computed)

Ticket and documentation¶

If a ticket may impact the documentation, add a line such as :
DOC: fix section x.x.x

Sourceforge SVN Usage¶

SVN folders structure¶

• copyright: contains copyright files
• corpora: contains samples binary corpus (deprecated)
• CWB: contains modified CWB sources (fix error logs, jni code)
• doc: contains all kind of TXM documentation
• groovy-all: contains a RCP dependency project to enable Groovy scripting in TXM
• installers : contains a linux environment to build TXM for all supported architectures (Debian, Windows and Mac OS X)
• libs: contains dependency projects (mandatory ones) of the TBX (and RCP ?) (groovy-all should be moved here)
• plugins: contains plugins for TXM (optional ones)
• RCP: contains the TXM RCP project
• sdk: contains environment to build TXM SDK
• textometry: contains the "textometry" R package sources
• Toolbox: contains the Toolbox main dependency of the RCP project
• translation: contains tools to translate TXM manual
• WEB: contains TXM portal sources

SVN commit messages¶

content
Each commit message must follow the syntax :

• prefix with *SOMETHING: *(space char)
• then insert the nature of the commit for example : add, fix...
• then insert the message content and details
• if you need more than one line to describe the entry, prefix the following lines with "#"

Prefixes
Prefixes are :

• RCP: the TXM desktop (RCP) project
• TBX: the Toolbox (TBX) project
• WEB: the TXM portal project
• DOC: the documentation of any project
• SETUP: * the project that contains scripts to build TXM setups
• GROOVYALL: the Groovy-all plugin (will move to LIBS)
• PLUGIN-<PLUGINNAME>: The extensions of TXM
• LIBS: The third libraries plugins used by the TBX or the RCP

Example

TBX: add an awesome new functionnality
TBX: fix the XXX import module
# the flow was not Groovy enough
# end of this entry
DOC: add documentation of the new functionnality

For further details about commit message syntax, follow those principles:

https://github.com/erlang/otp/wiki/Writing-good-commit-messages

Related projects¶

1. TXM for Oriflamms