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 status 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 and documentation¶
If a ticket may impact the documentation, add a line such as :
DOC: fix section x.x.x
Sourceforge SVN Usage¶
SVN commit messages¶
Each commit message must follow the syntax :- prefix with RCP: * or *TBX: * or *WEB: * or *DOC: * or *SETUP: * or *GROOVYALL or *PLUGIN-<PLUGINNAME>: * (for the optional extensions of TXM)
- 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 "#"
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