Tickets Creation

Version 7 (Matthieu Decorde, 06/01/2021 05:14 pm)

1 1 Severine Gedzelman
h1. Tickets Creation
2 1 Severine Gedzelman
3 2 Severine Gedzelman
4 2 Severine Gedzelman
{{>toc}}
5 2 Severine Gedzelman
6 1 Severine Gedzelman
General principles are described in the txm-info wiki: https://groupes.renater.fr/wiki/txm-info/public/transition_wiki_tickets
7 1 Severine Gedzelman
8 1 Severine Gedzelman
h2. Ticket template
9 1 Severine Gedzelman
10 1 Severine Gedzelman
11 5 Matthieu Decorde
h3. Feature and Task tickets
12 5 Matthieu Decorde
13 5 Matthieu Decorde
**title**
14 5 Matthieu Decorde
15 5 Matthieu Decorde
Pattern: "Command name, a small description sentence"
16 5 Matthieu Decorde
17 5 Matthieu Decorde
e.g.: Concordance, add a super parameter to manage lines
18 5 Matthieu Decorde
e.g.: Add a new super cool window dark theme
19 5 Matthieu Decorde
20 5 Matthieu Decorde
**description**
21 5 Matthieu Decorde
22 1 Severine Gedzelman
<pre>
23 1 Severine Gedzelman
Description of the objective and the context.
24 1 Severine Gedzelman
25 1 Severine Gedzelman
Link to the wiki specification page (if available).
26 1 Severine Gedzelman
27 1 Severine Gedzelman
h3. Solution
28 1 Severine Gedzelman
29 1 Severine Gedzelman
Steps and means to implement the ticket.
30 1 Severine Gedzelman
31 1 Severine Gedzelman
h3. Validation Test
32 1 Severine Gedzelman
33 1 Severine Gedzelman
Procedure to follow to validate the implementation of the ticket.
34 1 Severine Gedzelman
35 1 Severine Gedzelman
* action 1
36 1 Severine Gedzelman
* action 2
37 1 Severine Gedzelman
* action 3
38 1 Severine Gedzelman
</pre>
39 1 Severine Gedzelman
40 1 Severine Gedzelman
h3. Bug and Support ticket
41 1 Severine Gedzelman
42 5 Matthieu Decorde
**title**
43 5 Matthieu Decorde
44 5 Matthieu Decorde
Pattern: "[Command name,] Version, OS, a small description of the problem"
45 5 Matthieu Decorde
46 5 Matthieu Decorde
e.g.: Concordance, 0.8.0, Linux, everything is written in wrong direction
47 5 Matthieu Decorde
e.g.: 0.7.9, Windows/Mac OS X, everything is wrong
48 5 Matthieu Decorde
49 5 Matthieu Decorde
**description**
50 5 Matthieu Decorde
51 1 Severine Gedzelman
<pre>
52 5 Matthieu Decorde
Context and origin of the bug description (mail, TXM version, OS, etc.)
53 1 Severine Gedzelman
54 5 Matthieu Decorde
h3. Steps to reproduce
55 1 Severine Gedzelman
56 5 Matthieu Decorde
* step 1
57 5 Matthieu Decorde
* step 3
58 1 Severine Gedzelman
59 5 Matthieu Decorde
h3. Diagnostic 1
60 5 Matthieu Decorde
61 1 Severine Gedzelman
* Hypothesis
62 1 Severine Gedzelman
* Observation
63 1 Severine Gedzelman
* Conclusion
64 1 Severine Gedzelman
** the bug is reproduced
65 1 Severine Gedzelman
** the bug is not reproduced by this hypothesis
66 1 Severine Gedzelman
67 5 Matthieu Decorde
h3. Diagnostic 2
68 1 Severine Gedzelman
69 1 Severine Gedzelman
* Hypothesis
70 1 Severine Gedzelman
* Observation
71 1 Severine Gedzelman
* Conclusion
72 1 Severine Gedzelman
** the bug is reproduced
73 1 Severine Gedzelman
** the bug is not reproduced by this hypothesis
74 1 Severine Gedzelman
75 5 Matthieu Decorde
h3. Solution
76 1 Severine Gedzelman
77 1 Severine Gedzelman
Steps and means to resolve the ticket.
78 1 Severine Gedzelman
79 1 Severine Gedzelman
h3. Validation Test
80 1 Severine Gedzelman
81 1 Severine Gedzelman
Procedure to follow to validate the resolution of the ticket.
82 1 Severine Gedzelman
83 1 Severine Gedzelman
* action 1
84 1 Severine Gedzelman
* action 2
85 1 Severine Gedzelman
* action 3
86 1 Severine Gedzelman
</pre>
87 1 Severine Gedzelman
88 1 Severine Gedzelman
h2. Ticket categories definitions
89 1 Severine Gedzelman
90 1 Severine Gedzelman
Available ticket categories:
91 1 Severine Gedzelman
92 1 Severine Gedzelman
* Administration: portal administration interface and tools (Portal project)
93 1 Severine Gedzelman
* Charts: charts plotting issues
94 1 Severine Gedzelman
* Charts / R port from JFC: missing functionalities needed to be implemented in R charts engine from JFC charts engine and low priority issues since the default charts engine is now JFC
95 1 Severine Gedzelman
* Commands: any command related issue (all projects)
96 1 Severine Gedzelman
* Conventions:  algorithms and terminology conventions (all projects)
97 1 Severine Gedzelman
* Development: development tasks, installation and configuration of TXM development environment, RCP projects management, source code structure, etc.
98 1 Severine Gedzelman
* Documentation: any documentation issue (manuals, wikis, web pages...) (SH: Javadoc?)
99 1 Severine Gedzelman
* Import: any import module issue
100 1 Severine Gedzelman
* Network: network communication (despite of the component or layer, e.g. R, RCP, etc.)
101 1 Severine Gedzelman
* Preferences: RCP preferences issues
102 1 Severine Gedzelman
* Setup: desktop RCP setup issues
103 1 Severine Gedzelman
* Stats: statistic models issues
104 1 Severine Gedzelman
** Stats / R: R related statistic models issues
105 1 Severine Gedzelman
* Toolbox: any issue related to the Toolbox project
106 1 Severine Gedzelman
* UI: User Interface issues in the RCP project (SH: and GWT project?)
107 1 Severine Gedzelman
** UI / Interaction: user interface behavior issues
108 1 Severine Gedzelman
** UI / Link / Command: user interface hypertextual command behavior issues
109 1 Severine Gedzelman
110 1 Severine Gedzelman
h2. Ticket hierarchy policy
111 1 Severine Gedzelman
112 1 Severine Gedzelman
There are 2 usages:
113 1 Severine Gedzelman
* Grouping tasks
114 1 Severine Gedzelman
* Phasing tasks: children are steps and are ordered
115 1 Severine Gedzelman
116 1 Severine Gedzelman
h2. Ticket life cycle
117 1 Severine Gedzelman
118 1 Severine Gedzelman
Instructions for alpha testers:
119 1 Severine Gedzelman
* for a given release
120 1 Severine Gedzelman
* do the 'validation test' section of each ticket marked as 'Feedback'
121 1 Severine Gedzelman
* if the validation test cannot be passed, set the ticket percentage between 0-79 as an estimation of the remaining work to be done
122 1 Severine Gedzelman
* set the ticket to 'Resolved' state when the validation test is passed
123 1 Severine Gedzelman
124 1 Severine Gedzelman
Ticket status+percent follow this cycle:
125 1 Severine Gedzelman
* Developement cycle
126 1 Severine Gedzelman
** "New" + 0: the ticket is *not* being handled by the developer
127 1 Severine Gedzelman
** "InProgress" + 1-79: the ticket is being handled by the developer
128 1 Severine Gedzelman
** "InProgress" + 80: the ticket has been implemented and is *NOT* yet ready to be tested
129 1 Severine Gedzelman
* Alpha cycle
130 1 Severine Gedzelman
** "Feedback" + 80: the ticket has been implemented and is proposed to be tested by testers
131 1 Severine Gedzelman
** "Feedback" + 0-79: the ticket has been downgraded by the alpha tester from the 80 status
132 1 Severine Gedzelman
** "Resolved" + 90: the ticket has been validated by alpha testers
133 1 Severine Gedzelman
* Release cycle
134 1 Severine Gedzelman
** "Closed" + 100: the ticket has been validated on production portal or by beta testers= the ticket is closed
135 1 Severine Gedzelman
136 1 Severine Gedzelman
Warning: parent tickets don't follow that policy (percent is computed)
137 1 Severine Gedzelman
138 6 Matthieu Decorde
h2. Ticket and complexity evaluation
139 6 Matthieu Decorde
140 7 Matthieu Decorde
Use the "Estimated time/Temps estimé" field as a *resolution complexity rate* field. 
141 7 Matthieu Decorde
142 7 Matthieu Decorde
The rate value:
143 7 Matthieu Decorde
* starts from 0 (easy|quick) to 100 (very complex|long).
144 7 Matthieu Decorde
* is 50, if the complexity is unknown or need to be evaluated
145 6 Matthieu Decorde
146 1 Severine Gedzelman
h2. Ticket and documentation
147 1 Severine Gedzelman
148 6 Matthieu Decorde
If a ticket may impact the documentation: 
149 6 Matthieu Decorde
* add a line such as : "DOC: fix section x.x.x"
150 6 Matthieu Decorde
* set category to "Documentation"
151 3 Serge Heiden
152 3 Serge Heiden
h1. Complementary txm-info wiki specification page
153 3 Serge Heiden
154 3 Serge Heiden
If a txm-info wiki page is created to describe in more details information related to a ticket, the description must contain a direct link to that page. Use the *@page_name* syntax to refer to the page.
155 3 Serge Heiden
156 3 Serge Heiden
txm-info wiki specification page pattern : 
157 3 Serge Heiden
158 3 Serge Heiden
<pre>
159 4 Serge Heiden
====== Titre du développement (nom du composant, etc.) ======
160 1 Severine Gedzelman
161 4 Serge Heiden
Canevas de la spécification d'un développement.
162 4 Serge Heiden
163 4 Serge Heiden
164 3 Serge Heiden
===== Objectif =====
165 1 Severine Gedzelman
166 4 Serge Heiden
Description de l'objectif du développement.
167 4 Serge Heiden
168 4 Serge Heiden
169 1 Severine Gedzelman
===== Méthode =====
170 1 Severine Gedzelman
171 4 Serge Heiden
Description de la méthode de travail pour atteindre l'objectif.
172 4 Serge Heiden
173 3 Serge Heiden
==== État de la plateforme ====
174 1 Severine Gedzelman
175 4 Serge Heiden
Avancement dans l'élaboration de la solution.
176 3 Serge Heiden
177 4 Serge Heiden
178 1 Severine Gedzelman
===== Solution =====
179 3 Serge Heiden
180 4 Serge Heiden
Description de la solution choisie ou des solutions à choisir.
181 4 Serge Heiden
182 3 Serge Heiden
==== État de l'art ====
183 1 Severine Gedzelman
184 4 Serge Heiden
Éléments de solution.
185 4 Serge Heiden
186 1 Severine Gedzelman
==== Prototypes ====
187 4 Serge Heiden
188 4 Serge Heiden
Premières réalisations concrètes de la solution.
189 4 Serge Heiden
190 4 Serge Heiden
=== Alpha ou Étape 1 ===
191 4 Serge Heiden
192 4 Serge Heiden
=== Beta ou Étape 2 ===
193 4 Serge Heiden
194 1 Severine Gedzelman
==== Version finale ====
195 1 Severine Gedzelman
196 4 Serge Heiden
197 3 Serge Heiden
===== Documentation =====
198 4 Serge Heiden
199 4 Serge Heiden
Si possible, développer la documentation en même temps que la solution.
200 4 Serge Heiden
201 1 Severine Gedzelman
==== Utilisateur ====
202 4 Serge Heiden
203 1 Severine Gedzelman
==== Développeur ====
204 1 Severine Gedzelman
205 4 Serge Heiden
206 1 Severine Gedzelman
===== Recette =====
207 3 Serge Heiden
208 4 Serge Heiden
Tutoriel décrivant explicitement étape par étape l'usage concret de la solution pour valider sa conformité par rapport aux objectifs.
209 4 Serge Heiden
210 4 Serge Heiden
=== Alpha ou Étape 1 ===
211 4 Serge Heiden
212 4 Serge Heiden
=== Beta ou Étape 2 ===
213 4 Serge Heiden
214 4 Serge Heiden
etc.
215 4 Serge Heiden
216 1 Severine Gedzelman
</pre>