0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / dox / contribution / contribution_workflow / contribution_workflow.md
1 Contribution Workflow {#occt_contribution__contribution_workflow}
2 ====================================
3 @tableofcontents 
4
5 @section occt_contribution_intro Introduction
6
7 The purpose of this document is to describe standard workflow for processing contributions to certified version of OCCT. 
8
9 @subsection occt_contribution_intro_tracker Use of issue tracker system
10
11 Each contribution should have corresponding issue (bug, or feature, or integration request) 
12 registered in the MantisBT issue tracker system accessible by URL 
13 https://tracker.dev.opencascade.org.
14 The issue is processed according to the described workflow.
15
16 @subsection occt_contribution_intro_access Access levels
17
18 Access level defines the permissions of the user to view, register and modify issues in the issue tracker. 
19 The correspondence of access level and user permissions is defined in the table below.
20
21 | Access level  | Granted to       | Permissions       | Can set statuses         |
22 |:------------- | :--------- | :-------------- | :----------------------- |
23 | Viewer        | Everyone (anonymous access)   | View public issues only    | None |
24 | Updater       | Users registered on dev.opencascade.org, in Open CASCADE project | View  and comment issues | None |
25 | Reporter      | Users registered on dev.opencascade.org, in Community project | View, report, and comment issues  | New, Resolved, Feedback |
26 | Developer     | OCC developers and (in Community project) external contributors who signed the CLA | View, report, modify, and handle issues | New, Assigned, Resolved, Reviewed, Feedback |
27 | Tester        | OCC engineer devoted to certification testing | View, report, modify, and handle issues | Assigned, Tested, Feedback |
28 | Maintainer    | Person responsible for a project or OCCT component | View, report, modify, and handle issues | New, Resolved, Reviewed, Tested, Closed, Feedback |
29 | Bugmaster     | Person responsible for Mantis issue tracker, integrations, certification, and releases | Full access | All statuses |
30
31 According to his access level, the user can participate in the issue handling process under different roles, as described below.
32
33 @section occt_contribution_workflow Standard workflow for an issue
34
35 @subsection occt_contribution_workflow_general General scheme
36
37 <center>
38 @figure{OCCT_ContributionWorkflow_V3_image001.svg,"Standard life cycle of an issue",360}
39 </center>
40   
41 @subsection occt_contribution_workflow_issue Issue registration
42
43 An issue is registered in Mantis bugtracker by the **Reporter** with definition of the necessary attributes (see also @ref occt_contribution_app):
44
45 **Category** -- indicates the OCCT component, to which the issue relates.
46     (If in doubt, assign to OCCT:Foundation Classes.)
47
48 **Severity** -- indicates the impact of the issue in the context where it was discovered.
49
50 **Profile** -- specifies the configuration, on which the problem was detected. 
51 For specific configurations it is possible to specify separately platform, OS, and version.
52 These fields can be left empty if the issue is not configuration-specific.
53 Additional details relevant for the environment where the issue is reproduced (such as compiler version, bitness, etc.) can be provided in the **Description**.
54
55 **Products Version** -- defines the OCCT version, on which the problem has been detected.
56
57 It is preferable to indicate the version of the earliest known official release where the problem can be reproduced.
58 If the issue is reported on the current development version of OCCT, the current development version should be used (for convenience, this version is marked by asterisk in Mantis).
59     
60 @note OCCT version number can be consulted in the file Standard_Version.hxx (value of OCC_VERSION_COMPLETE macro).
61
62 **Assign to** -- developer to whom the issue will be assigned. 
63     By default, it is set to **Maintainer** of the OCCT component selected in **Category** field.
64
65 **Target Version** -- defines the target version for the fix to be provided.
66     By default, it is set to the current version under development.
67
68 **Summary** -- a short, one sentence description of the issue. 
69   
70 The **Summary** has a limit of 128 characters. 
71 It should be informative and useful for the developers. 
72 It is not allowed to mention the issue originator, and in particular the customer, in the name of the registered issue.
73
74 A good practice is to start the issue with indication of the relevant component (OCCT module, package, class etc.) to better represent its context.
75
76 The summary should be given in imperative mood when it can be formulated as goal to be achieved or action to be done.
77 In particular, this applies to feature requests and improvements, for instance:
78
79 > *Visualization - provide a support of zoom persistent selection*
80
81 If the issue reports a problem, the summary should be given in Present Simple.
82 If reported problem is believed to be a regression, it is recommended to indicate this in the summary, like this:
83
84 > [Regression in 6.9.0] *IGES - Export of a reversed face leads to wrong data*
85
86 **Description** -- should contain a detailed definition of the nature of the registered issue depending on its type. 
87
88 For a bug it is required to submit a detailed description of the incorrect behavior, including the indication of the cause of the problem (if known at this stage), and details on the context where the issue has been detected.
89
90 For a feature or integration request it is necessary to describe the proposed feature in details (as much as possible at that stage), including the changes required for its implementation and the main features of the new functionality. 
91
92 Example:
93
94 > *Currently selection does not work correctly for non-zoomable objects (those defined using transform persistence). To provide correct selection for such objects, first-level (object) BVH structures must be updated on each camera change, and frustum must be rebuilt accordingly.*
95
96 @note In the description and notes to the issues you can refer to another issue by its ID prefixed by number sign (e.g.: #12345), and refer to a note by its ID prefixed by tilde (e.g.: ~20123). 
97 These references will be expanded by Mantis into links to the corresponding issue or note. 
98 When the number sign or the tilde followed by digits are a part of a normal text, add a space before digits (e.g.: "face # 12345 contains ~ 1000 edges") to avoid this conversion.
99
100 **Steps To Reproduce** -- allows describing in detail how to reproduce the issue. 
101
102 This information is crucial for the developer to investigate the cause of the problem and to create the test case.
103 The optimal approach is to give a sequence of @ref occt_user_guides__test_harness "DRAW Test Harness" commands to reproduce the problem in DRAW.
104 This information can also be provided as a DRAW Tcl script attached to the issue (in **Upload File** field).
105
106 **Additional information and documentation updates** -- any additional information, remarks to be taken into account in Release Notes, etc.. 
107
108 **Upload File** -- allows attaching the shapes, snapshots, scripts, documents, or modified source files of OCCT. 
109
110 This field can be used to attach a prototype test case in form of a Tcl script for DRAW, a C++ code which can be organized in DRAW commands, sample shapes, documents describing proposed change or analysis of the problem, or other data required for reproduction of the issue.
111 Where applicable, pictures demonstrating a problem and/or desired result can be attached.
112   
113 The newly registered issue gets status **NEW** and is assigned to the person indicated in the **Assign to** field. 
114
115 @subsection occt_contribution_workflow_assign Assigning the issue
116
117 The description of the new issue is checked by the **Maintainer** and if it is feasible, he may assign the issue to a **Developer**.
118 Alternatively, any user with **Developer** access level or higher can assign the issue to himself if he wants to provide a solution. 
119   
120 The recommended way to handle contributions is that the **Reporter** assigns the issue to himself and provides a solution.
121
122 The **Maintainer** or **Bugmaster** can close or reassign the issue (in **FEEDBACK** state) to the **Reporter** after it has been registered, if its description does not contain sufficient details to reproduce the bug or explain the need of the new feature. 
123 That decision shall be documented in the comments to the issue in the Bugtracker.
124
125 The assigned issue has status **ASSIGNED**.
126
127 @subsection occt_contribution_workflow_fix Resolving the issue
128
129 The **Developer** responsible for the issue assigned to him provides a solution including:
130
131 * Changes in the code, with appropriate comments;
132 * Test case (when applicable) and data necessary for its execution;
133 * Changes in the user and developer guides (when necessary).
134
135 The change is integrated to branch named CRxxxxx (where **xxxxx** is issue number) in the OCCT Git repository, based on current master, and containing a single commit with the appropriate description.
136 Then the issue is switched to **RESOLVED** for further review and testing.
137
138 The following sub-sections describe this process, relevant requirements and options, in more details.
139
140 @subsubsection  occt_contribution_workflow_fix_code Requirements to the code modification
141  
142 The amount of code affected by the change should be limited to the changes required for the bug fix or improvement.
143 Change of layout or re-formatting of the existing code is allowed only in the parts where meaningful changes related to the issue have been made.
144
145 @note If deemed useful, re-formatting or cosmetic changes affecting considerable parts of the code can be made within a dedicated issue.
146
147 The changes should comply with the OCCT @ref occt_contribution__coding_rules "Codng Rules". 
148 It is especially important to comment the code properly so that other people can understand it easier.
149
150 The modification should be tested by running OCCT tests (on the platform and scope available to **Developer**) and ensuring absence of regressions.
151 In case if modification affects results of some existing test case and the new result is correct,
152 such test case should be updated to report OK (or BAD), as described in @ref testmanual_details_results "Automated Test System / Interpretation of Test Results".
153       
154 @subsubsection occt_contribution_workflow_fix_test Providing a test case
155
156 For modifications affecting OCCT functionality, a test case should be created (unless already exists) and included in the commit or patch.
157 See @ref testmanual_intro_quick_create "Automated Test System / Creating a New Test" for relevant instructions.
158
159 The data files required for a test case should be attached to the corresponding issue in Mantis (i.e. not included in the commit).
160
161 When the test case cannot be provided for any reason, the maximum possible information on how the problem can be reproduced and how to check the fix should be provided in the **Steps to Reproduce** field of an issue.
162
163 @subsubsection  occt_contribution_workflow_fix_doc Updating user and developer guides
164
165 If the change affects a functionality described in @ref user_guides "User Guides", the corresponding user guide should be updated to reflect the change.
166
167 If the change affects OCCT test system, build environment, or development tools described in @ref build_upgrade "Build, Debug and Upgrade" or @ref contribution "Contribution", the corresponding guide should be updated.
168  
169 The changes that break compatibility with the previous versions of OCCT (i.e. affecting API or behavior of existing functionality in the way that may require update of existing applications based on an earlier official release of OCCT to work correctly) should be described in the document @ref occt__upgrade "Upgrade from previous OCCT versions".
170 It is recommended to add a sub-section for each change described.
171 The description should provide the explanation of the incompatibility introduced by the change, and describe how it can be resolved (at least, in known situations).
172 When feasible, the automatic upgrade procedure (adm/upgrade.tcl) can be extended by a new option to perform the required upgrade of the dependent code automatically. 
173
174 @subsubsection  occt_contribution_workflow_fix_git Submission of change as a Git branch
175   
176 The modification of sources should be provided in the dedicated branch of the official OCCT Git repository.
177
178 The branch should contain a single commit, with the appropriate commit message (see @ref occt_contribution_workflow_fix_commit "Requirements to the commit message" below).
179
180 In general, this branch should be based on the recent version of the master branch.
181 It is highly preferable to submit changes basing on the current master.
182 In case if the fix is implemented on the previous release of OCCT, the branch can be based on the corresponding tag in Git, instead of the master.
183   
184 The branch name should be composed of letters **CR** (abbreviation of "Change Request") followed by the issue ID number (without leading zeros). 
185 It is possible to add an optional suffix to the branch name after the issue ID, e.g. to distinguish between several versions of the fix (see @ref occt_contribution_nonstd_rebase).
186
187 See @ref occt_contribution__git_guide "Guide to using GIT" for help.
188
189 @note When a branch with the name given according to the above rule is pushed to Git, a note is automatically added to the corresponding issue in Mantis, indicating the person who has made the push, the commit hash, and (for new commits) the description.
190   
191 @subsubsection  occt_contribution_workflow_fix_commit Requirements to the commit message
192
193 The commit message posted in Git constitutes an integral part of both the fix and the release documentation.
194
195 The first line of the commit message should contain the Summary of the issue (starting with its ID followed by colon, e.g. "0022943: Bug in TDataXtd_PatternStd"), followed by an empty line. 
196
197 The following lines should provide a description of the context and details on the changes made.
198 The contents and the recommended structure of the description depend on the nature of the bug. 
199   
200 In a general case, the following elements should be present:
201 * **Problem** -- a description of the unwanted behavior;
202 * **Change** -- a description of the implemented changes, including the names of involved classes / methods / enumerations etc.;
203 * **Result** -- a description of the current behavior (after the implementation).
204
205 Example:
206
207 > *0026330: BRepOffsetAPI_ThruSections creates invalid shape.*
208 >
209 > *Methods BRep_Tool::CurveOnSurface() and BRepCheck_Edge::InContext() now properly handle parametric range on a 3D curve when it is used to generate a p-curve dynamically (on a planar surface) and both the surface and the 3D curve have non-null locations.*
210
211 Provide sufficient context so that potential user of the affected functionality can understand what has been changed and how the algorithm works now.
212 Describe reason and essence of the changes made, but do not go too deep into implementation details -- these should be reflected in comments in the code.
213
214 @subsubsection occt_contribution_workflow_fix_resolve Marking issue as resolved
215
216 To mark the change as ready for review and testing, the corresponding issue should be switched to **RESOLVED** state.
217 By default, the issue gets assigned to the **Maintainer** of the component, who is thus responsible for its review. 
218 Alternatively, another person can be selected as a reviewer at this step.
219
220 When the issue is switched to **RESOLVED**, it is required to update or fill the field **Steps to reproduce**.
221 The possible variants are:
222
223 * The name of an existing or new test case (preferred variant);
224 * A sequence of DRAW commands;
225 * N/A (Not required / Not possible / Not applicable);
226 * Reference to an issue in the bug tracker of another project.
227
228 @subsection occt_contribution_workflow_review Code review
229
230 The **Reviewer** analyzes the proposed solution for applicability in accordance with OCCT @ref occt_contribution__coding_rules "Coding Rules" and examines all changes in the sources, test case(s), and documentation to detect obvious and possible errors, misprints, or violations of the coding style. 
231
232 If the Reviewer detects some problems, he can either:
233
234 * Fix these issues and provide a new solution. 
235   The issue can then be switched to **REVIEWED**. 
236   
237   In case of doubt or possible disagreement the **Reviewer** can reassign the issue (in **RESOLVED** state) to the **Developer**, who then becomes a **Reviewer**. 
238   Possible disagreements should be resolved through discussion, which is done normally within issue notes (or on the OCCT developer’s forum if necessary).
239
240 * Reassign the issue back to the **Developer**,  providing detailed list of remarks. The issue then gets status **ASSIGNED** and a new solution should be provided.
241     
242 If Reviewer does not detect any problems, or provides a corrected version, he changes status to **REVIEWED**.
243 The issue gets assigned to the **Bugmaster**.
244
245 @subsection occt_contribution_workflow_test Testing
246
247   The issues that are in **REVIEWED** state are subject of certification (non-regression) testing. 
248   The issue is assigned to an OCCT **Tester** when he starts processing it.
249
250   If the branch submitted for testing is based on obsolete status of the master branch, **Tester** @ref occt_contribution_nonstd_rebase "rebases" it on master HEAD.
251   In case of conflicts, the issue is assigned back to **Developer** in **FEEDBACK** status, requesting for a rebase.
252
253   Certification testing includes:
254         * Addition of new data models (if required for a new test case) to the data base;
255     * Revision of the new test case(s) added by developer, and changes in the existing test cases included in commit. 
256           The **Tester** can amend tests to ensure their correct behavior in the certification environment.
257     * Building OCCT on a sub-set of supported configurations (OS and compiler), watching for errors and warnings;
258         * Execution of tests on sub-set of supported platforms (at least, one Windows and one Linux configuration), watching for regressions;
259         * Building OCCT samples, watching for errors;
260         * Building and testing of OCC products based on OCCT.
261
262 If the **Tester** does not detect problems or regressions, he changes the status to **TESTED** for further integration.
263
264 If the **Tester** detects build problems or regressions, he changes the status to **ASSIGNED** and reassigns the issue to the **Developer** with a detailed description of the problems. 
265 The **Developer** should analyze the reported problems and, depending on results of this analysis, either:
266 * Confirm that the detected problems are expected changes and they should be accepted as a new status of the code. Then the issue should be switched to **FEEDBACK** and assigned to the **Bugmaster**.
267 * Produce a new solution (see @ref occt_contribution_workflow_fix, and also @ref occt_contribution_nonstd_minor).
268
269 @subsection occt_contribution_workflow_integrate Integration of a solution
270
271 Before integration into the master branch of the repository the **Integrator** checks the following conditions:
272     * the change has been reviewed;
273     * the change has been tested without regressions (or with regressions treated properly);
274     * the test case has been created for this issue (when applicable), and the change has been rechecked on this test case;
275     * the change does not conflict with other changes integrated previously.
276   
277 If the result of check is successful the Integrator integrates the solution into the branch.
278 The integrations are performed weekly; integration branches are named following the pattern IR-YYYY-MM-DD.
279
280 Each change is integrated as a single commit without preserving the history of changes made in the branch (by rebase, squashing all intermediate commits if any), however, preserving the author when possible.
281 This is done to have the master branch history plain and clean.
282 The following picture illustrates the process:
283   
284 @figure{OCCT_ContributionWorkflow_V3_image002.png,"Integration of several branches",420}
285   
286 The new integration branch is tested against possible regressions that might appear due to interference between separate changes.
287 When the tests are OK, the integration branch is pushed as the new master to the official repository.
288 The issue status is set then to **VERIFIED** and is assigned to the **Reporter** so that he could check the fix as integrated.
289
290 The branches corresponding to the integrated fixes are removed from the repository by the **Bugmaster**.
291
292 @subsection occt_contribution_workflow_close Closing an issue
293
294 When possible, the **Reporter** should check whether the problem is actually resolved in the environment where it has been discovered, after the fix is integrated to master.
295 If the fix does not actually resolve the original problem, the issue in **VERIFIED** status can be reopened and assigned back to the **Developer** for rework.
296 The details on how to check that the issue is still reproducible should be provided.
297 However, if the issue does resolve the problem as described in the original report, but a similar problem is discovered for another input data or configuration, or the fix has caused a regression, that problem should be registered as a separate (@ref occt_contribution_nonstd_relate "related") issue.
298
299 If the fix integrated to master causes regressions, **Bugmaster** can revert it and reopen the issue.
300
301 The **Bugmaster** closes the issue after the regular OCCT Release, provided that the issue status is **VERIFIED** and the change was actually included in the release.
302 The final issue state is **CLOSED**.
303
304 The field **Fixed in Version** of the issue is set to the OCCT version where it is fixed.
305
306 @section occt_contribution_nonstd Additional workflow elements
307
308 @subsection occt_contribution_nonstd_feedback Requesting more information or specific action
309
310 If, at any step of the issue lifetime, the person responsible for it cannot process it due to absence of required information, expertise, or rights, he can switch it to status **FEEDBACK** and assign to the person who is (presumably) able to resolve the block. Some examples of typical situations where **FEEDBACK** is used are:
311
312 * The **Maintainer** or the **Developer** requests for more information from the **Reporter** to reproduce the issue;
313 * The **Tester** requests the **Developer** or the **Maintainer** to help him in the interpretation of testing results; 
314 * The **Developer** or the **Maintainer** asks the **Bugmaster** to close the issue that is found irrelevant or already fixed (see @ref occt_contribution_nonstd_autofix).
315
316 In general, issues with status **FEEDBACK** should be processed as fast as possible, to avoid unjustified delays.
317
318 @subsection occt_contribution_nonstd_relate Defining relationships between issues
319
320 When two or more issues are related to each other, this relationship should be reflected in the issue tracker.
321 It is also highly recommended to add a note to explain the relationship.
322 Typical cases of relationships are:
323
324 * Issue A is caused by previous fix made for issue B (A is a child of B);
325 * Issue A describes the same problem as issue B (A is a duplicate of B);
326 * Issues A and B relate to the same piece of code, functionality etc., in the sense that the fix for one of these issues will affect the other (A is related to B)
327
328 When the fix made for one issue also resolves  another one, these issues should be marked as related or duplicate.
329 In general, the duplicate issue should have the same status, and, when closed, be marked as fixed in the same OCCT version, as the main one.
330
331 @subsection  occt_contribution_nonstd_patch Submission of a change as a patch
332   
333 In some cases (if Git is not accessible for the contributor), external contributions can be submitted as a patch file (generated by *diff* command) or as modified sources attached to the Mantis issue.
334 The OCCT version, for which the patch is generated, should be clearly specified (e.g. as hash code of Git commit if the patch is based on an intermediate state of the master).
335   
336 @note Such contributions should be put to Git by someone else (e.g. the **Reviewer**), this may cause delay in their processing.
337   
338 @subsection occt_contribution_nonstd_rebase Updating branches in Git
339
340 Updates of the existing branch (e.g. taking into account the remarks of the **Reviewer**, or fixing regressions) should be provided as new commits on top of previous state of the branch.
341
342 It is allowed to rebase the branch on the new state of the master and push it to the repository under the same name (with <i>--force</i> option) provided that the original sequence of commits is preserved.
343
344 When a change is squashed into a single commit (e.g. to be submitted for review), it should be pushed into a branch a with different name.
345
346 The recommended approach is to add a numeric suffix (index) indicating the version of the change, e.g. "CR12345_5".
347 Usually it is worth keeping a non-squashed branch in Git for reference.
348
349 To avoid confusions, the branch corresponding to the latest version of the change should have a greater index.
350
351 @note Make sure to revise the commit message after squashing a branch, to keep it meaningful and comprehensive.
352
353 @subsection occt_contribution_nonstd_minor Minor corrections
354
355 In some cases review remarks or results of testing require only minor corrections to be done in the branch containing a change.
356 "Minor" implies that the correction does not impact the functionality and does not affect the description of the previously committed change.
357
358 As an exception to general @ref occt_contribution_workflow_fix_git "single-commit rule", it is allowed to put such minor corrections on top of the existing branch as a separate commit, and re-submit it for further processing in the same branch, without squashing.
359
360 Minor commits should have a single-line message starting with #.
361 These messages will be ignored when the branch is squashed at integration.
362
363 Typical cases of minor corrections are:
364
365 * Amendments of test cases (including those made by the **Tester** to adjust a test script to a specific platform);
366 * Trivial corrections of compilation warnings (such as removal of an unused variable);
367 * Addition or correction of comments or documentation;
368 * Corrections of code formatting (e.g. reversion of irrelevant formatting changes made in the main commit).
369
370 @subsection occt_contribution_nonstd_autofix Handling non-reproducible issues
371
372 Investigation of each issue starts with reproducing it on current development version (master).
373
374 If it cannot be reproduced on the current master, but can be reproduced on one of previous releases (or previous state of the master), it is considered as solved by a change made for another issue.
375 If that "fixing" issue can be identified (e.g. by parsing Git log), it should be set as related to that issue.
376 The issue should be switched to **FEEDBACK** and assigned to the **Bugmaster** for further processing.
377
378 The **Bugmaster** decides whether it is necessary to create a test case for that issue, and if so may assign it to the **Developer** or the **Tester** to create a test.
379 The issue then follows the standard workflow.
380
381 Otherwise, if the issue is fixed in one of previous releases, the **Bugmaster** closes it setting the appropriate value in **Fixed in Version** field, or, if the issue is fixed after the last release, switches it to **VERIFIED** status.
382
383 If the issue cannot be reproduced due to an unclear description, missing data, etc., it should be assigned back to the **Reporter** in **FEEDBACK** status, requesting for more information.
384 The **Reporter** should provide additional information within one month; after that time, if no new information is provided, the issue should be closed by the **Bugmaster** with resolution **Unable to reproduce**. 
385
386 @section occt_contribution_app Appendix: Issue attributes
387
388 @subsection occt_contribution_app_category Category
389
390 The category corresponds to the component of OCCT where the issue is found:
391     
392   |              Category        |                       Component                        |
393   | :--------------------------- | :----------------------------------------------------- |
394   | OCCT:Foundation Classes      | Foundation Classes module                              |
395   | OCCT:Modeling Data           | Modeling Data classes                                  |
396   | OCCT:Modeling Algorithms     | Modeling Algorithms, except shape healing and meshing  |
397   | OCCT:Shape Healing           | Shape Healing component (TKShapeHealing)               |
398   | OCCT:Mesh                    | BRepMesh algorithm                                     |
399   | OCCT:Data Exchange           | Data Exchange module                                   |
400   | OCCT:Visualization           | Visualization module                                   |
401   | OCCT:Application Framework   | OCAF                                                   |
402   | OCCT:DRAW                    | DRAW Test Harness                                      |
403   | OCCT:Tests                   | Automatic Test System                                  |
404   | OCCT:Documentation           | Documentation                                          |
405   | OCCT:Coding                  | General code quality                                   |
406   | OCCT:Configuration           | Configuration, build system, etc.                      |
407   | OCCT:Releases                | Official OCCT releases                                 |
408   | Website:Tracker              | OCCT Mantis issue tracker, tracker.dev.opencascade.org |
409   | Website:Portal               | OCCT development portal, dev.opencascade.org           |
410   | Website:Git                  | OCCT Git repository, git.dev.opencascade.org           |
411
412
413 @subsection occt_contribution_app_severity Severity
414
415   Severity shows at which extent the issue affects the product. 
416   The list of used severities is given in the table below in the descending order.
417   
418   | Severity    |                  Description                      |
419   | :---------- | :------------------------------------------------ |
420   | crash       | Crash of the application or OS, loss of data      |
421   | block       | Regression corresponding to the previously  delivered official version. Impossible  operation of a function on any data with no work-around. Missing function previously requested in software requirements specification.   Destroyed data. |
422   | major       | Impossible operation of a function with existing work-around. Incorrect operation of a function on a particular dataset. Impossible operation of a function after intentional input of incorrect data. Incorrect behavior of a function   after intentional input of incorrect data. |
423   | minor       | Incorrect behavior of a function corresponding  to the description in software requirements specification. Insufficient performance  of a function. |
424   | tweak       | Ergonomic inconvenience, need of light updates. |
425   | text        | Non-conformance of the program code to the Coding Rules, mistakes and non-functional errors in the source text  (e.g. unnecessary variable declarations, missing comments, grammatical errors in user manuals). |
426   | trivial     | Cosmetic issues.                                    |
427   | feature     | Request for a new feature or improvement. |
428   | integration request | Requested integration of an existing feature into the product. |
429   | just a question       | A question to be processed, without need   of any changes in the product. |
430
431 @subsection occt_contribution_app_status Status
432
433   The bug statuses that can be applied to the issues are listed in the table below. 
434   
435   | Status               |  Description                                                        |
436   | :------------------- | :----------------------------------------- |
437   | New                  | A new, just registered issue. |
438   | Acknowledged         | Can be used to mark the issue as postponed. |
439   | Confirmed            | Can be used to mark the issue as postponed. |
440   | Feedback             | The issue requires more information or a specific action. |
441   | Assigned             | Assigned to a developer.  |
442   | Resolved             | The issue has been fixed, and now is waiting for review.  |
443   | Reviewed             | The issue has been reviewed, and now is waiting for testing (or being tested). |
444   | Tested               | The fix has been internally tested by the tester with success on the full non-regression database or its part and a test case has been created for this issue. |
445   | Verified             | The fix has been integrated into the master of the corresponding repository |
446   | Closed + resolution  | The fix has been integrated to the master. The corresponding test case has been executed successfully. The issue is no longer reproduced. |
447
448 @subsection occt_contribution_app_resolution Resolution
449
450   **Resolution** is set when the bug is closed. "Reopen" resolution is added automatically when the bug is reopened.
451
452   | Resolution            |                               Description                                    |
453   |:--------------------- | :--------------------------------------------------------------------------- |
454   | Open                  | The issue is pending.                                                        |
455   | Fixed                 | The issue has been successfully fixed.                                       |
456   | Reopened              | The bug has been reopened because of insufficient fix or regression.         |
457   | Unable to reproduce   | The bug is not reproduced.                                                   |
458   | Not fixable           | The bug cannot be fixed because e.g. it is a bug of third party software, OS or hardware limitation, etc. |
459   | Duplicate             | The bug for the same issue already exists in the tracker.                    |
460   | Not a bug             | It is a normal behavior in accordance with the specification of the product. |
461   | No change required    | The issue didn’t require any change of the product, such as a question issue.|
462   | Suspended             | The issue is postponed (for Acknowledged status).                            |
463   | Documentation updated | The documentation has been updated to resolve a misunderstanding causing the issue. |
464   | Won’t fix             | It is decided to keep the existing behavior.                                     |
465