Wiki
Version 11 (Nils Kredens, 26/08/2013 11:07) → Version 12/65 (Matthieu Decorde, 04/09/2013 11:32)
h1. General Principles of TXM forge
h2. Using Tickets
h3. Ticket description
The description can contain a link to a txm-info Wiki page. Use the syntaxe *@page_name* to refer to the page.
h3. Ticket categories definition
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
h3. Ticket status cycle
Ticket status follow this cycle:
New -> In Progress -> Feedback -> Closed
* +New:+ the ticket concerns a demand not yet handled
* +In Progress:+ the demand is currently being handled
* +Feedback:+ the solution is developed and being tested and awaits the other users and developers feedback
* +Closed:+ the solution is approved and is deployed throughout the application. The ticket is done.
Other status that can occur at any time in the development:
* +Rejected:+ the demand is not to be handled
h2. Using SVN
h3. SVN commit messages
Each commit message must follow the syntax :
* prefix with *RCP: * *RCP:* or *TBX: * *TBX:* or *WEB: * *WEB:* or *DOC: * *DOC:* or *SETUP: * or *<plugin name>: * name>:*
* 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:
<pre>
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
</pre>
For further details about commit message syntax, follow those principles:
https://github.com/erlang/otp/wiki/Writing-good-commit-messages
h2. Using Tickets
h3. Ticket description
The description can contain a link to a txm-info Wiki page. Use the syntaxe *@page_name* to refer to the page.
h3. Ticket categories definition
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
h3. Ticket status cycle
Ticket status follow this cycle:
New -> In Progress -> Feedback -> Closed
* +New:+ the ticket concerns a demand not yet handled
* +In Progress:+ the demand is currently being handled
* +Feedback:+ the solution is developed and being tested and awaits the other users and developers feedback
* +Closed:+ the solution is approved and is deployed throughout the application. The ticket is done.
Other status that can occur at any time in the development:
* +Rejected:+ the demand is not to be handled
h2. Using SVN
h3. SVN commit messages
Each commit message must follow the syntax :
* prefix with *RCP: * *RCP:* or *TBX: * *TBX:* or *WEB: * *WEB:* or *DOC: * *DOC:* or *SETUP: * or *<plugin name>: * name>:*
* 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:
<pre>
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
</pre>
For further details about commit message syntax, follow those principles:
https://github.com/erlang/otp/wiki/Writing-good-commit-messages