0024336: Content of OCCT documentation should be updated. Iter 2
[occt.git] / dox / dev_guides / contribution_workflow / contribution_workflow.md
bf62b306 1Contribution Workflow {#dev_guides_contribution_workflow}
5@section occt_contribution_workflow_1 Introduction
7The purpose of this document is to describe standard workflow for processing contributions to certified version of OCCT.
9@subsection occt_contribution_workflow_1_1 Use of issue tracker system
11Each contribution should have corresponding issue (bug, or feature, or integration request)
12registered in the MantisBT issue tracker system accessible by URL
14The issue is processed further according to the described workflow.
16@subsection occt_contribution_workflow_1_2 Access Levels
18 Access level defines the permissions of the user to view,
19 register and modify issues in a Mantis bugtracker.
20 The correspondence of access level and user permissions
21 is defined in accordance with the table below.
23| Access level | Granted to | Permissions | Can set statuses |
24|:------------- | :--------- | :-------------- | :----------------------- |
25| Viewer | Everyone (anonymous access) | View public issues only | No |
26| Reporter | Users registered on dev.opencascade.com | View, report, and comment issues | New, Resolved |
27| Updater | Users of dev.opencascade.com in publicly visible projects | View and comment issues | New, Resolved |
28| Developer | OCC developers and external contributors who signed the CLA | View, report, modify, and handle issues | New, Assigned, Resolved, Reviewed |
29| Tester | OCC engineer devoted to certification testing | View, report, modify, and handle issues | Assigned, Tested |
30| Manager | Person responsible for a project or OCCT component | View, report, modify, and handle issues | New, Resolved, Reviewed, Tested, Closed |
32According to his access level, the user can participate in the issue handling process under different roles, as described below.
34@section occt_contribution_workflow_2 Typical workflow for an issue
36@subsection occt_contribution_workflow_2_1 General scheme
38@image html OCCT_ContributionWorkflow_V3_image001.png "Standard life cycle of an issue"
39@image latex OCCT_ContributionWorkflow_V3_image001.png "Standard life cycle of an issue"
41@subsection occt_contribution_workflow_2_2 Issue registration
43An issue is registered in Mantis bugtracker by the Reporter with definition of the necessary attributes.
44The definition of the following attributes is obligatory:
46 * **Category** - indicates component of OCCT to which the issue relates. If in doubt, assign OCCT:Foundation Classes.
47 * **Reproducibility**
48 * **Severity**
49 * **Priority**
50 * **Profile** - allows defining the platform on which the problem was detected from the list of predefined platforms. If a platform is absent in the list of predefined platforms it is possible to use Or Fill In option to define the platform manually.
51 * **Platform**
52 * **OS**
53 * **OS Version**
54 * **Products Version** - defines the version of Open CASCADE on which the problem has been detected.
55 * **Summary** - a short, one sentence description of the issue. It has a limit of 128 characters. It should be informative and useful for the developers. It is advisable to avoid vague or misleading phrases, such as "it doesn't work" or "it crashed". It is not allowed to mention the issue originator, and in particular the customer, in the name of the registered issue.
56 * **Description** - should contain a detailed definition of the nature of the registered issue depending on its type. 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 possible at this stage) or any inputs from the originator. For a feature or integration request it is recommended to describe the proposed feature in details (as possible at that stage), including the changes required for its implementation and the main features of the new functionality. Filling the bug description is obligatory.
57 * **Steps To Reproduce** - in this field it is possible to describe in detail how to reproduce the issue. This field considerably helps to find the cause of the problem, to eliminate it and to create the test case.
58 * *Upload File* field allows attaching the shapes, scripts or modified source files of OCCT. It is recommended to attach a prototype test case in form of a Tcl script for DRAW, using either existing DRAW commands, or a C++ code which can be organized in DRAW commands, as well as sample shapes or other input data (if applicable), immediately after the issue registration.
60 The newly registered issue gets status **NEW** and is assigned to the developer responsible for the OCCT component indicated in the Category field (Maintainer).
62@subsection occt_contribution_workflow_2_3 Assigning the issue
64 The description of the new issue is checked by the **Maintainer** and if it is feasible,
65 he may assign the issue to a **Developer**. Alternatively, any user with **Developer** access level
66 or higher can assign the issue to himself if he wants to provide a solution.
68 The recommended way to handle contributions is that the **Reporter** assigns the issue to himself and provides a solution.
70 The **Maintainer, Technical Project Manager,** or **Bugmaster** can close or reassign the issue
71 (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 purpose of the new feature.
72 That decision shall be documented in the comments to the issue in the Bugtracker.
74 The assigned issue should have state **ASSIGNED**.
76@subsection occt_contribution_workflow_2_4 Resolving the issue
78 The **Developer** responsible for the issue assigned to him provides a solution
79 as a change on the version of OCCT indicated in the issue attributes, or the last development version.
81 The modified sources should be submitted for review and testing to the dedicated branch of the official OCCT Git repository:
83 * Branch should be created for the issue with name composed of letters ‘CR’ followed by issue ID number (without leading zeroes).
84 Optional suffix can be added to the branch name after issue ID,
85 e.g. to distinguish between several version of the fix.
86 * The branch should be based on recent version of the master branch
87 (not later than commit tagged as last OCCT release).
88 * The first line of the first commit message should contain
89 the Summary of the issue (starting with its ID followed by colon, e.g. "0022943: Bug TDataXtd_PatternStd").
90 The consequent lines should contain a description of the changes made.
91 If more than one commit has been made, the commit messages should contain description of the changes made.
92 * The amount of the code affected by the change should be limited
93 to only the changes required for the bug fix or improvement.
94 Change of layout or re-formatting of the existing code is allowed
95 only in the parts where meaningful changes related to the issue have been made.
96 * The name of the branch where the fix is submitted should be given
97 in the note to the Mantis issue
98 (providing the direct link to relevant branch view in GitWeb is encouraged).
99 * The description of the changes made should be put to the field
100 "Additional information and documentation updates" of the Mantis issue.
102 In some cases (if Git is not accessible for the contributor),
103 external contributions can be submitted as patch (diff) files or sources
104 attached to the Mantis issue, with indication of OCCT version on which the fix is made.
105 Such contributions should be put to Git for processing by someone else,
106 and hence they have less priority in processing than the ones submitted directly through Git.
108 The issue for which solution is provided should be switched to **RESOLVED** state
109 and assigned to the developer who is expected to make a code review
110 (the **Reviewer**; by default, can be set to the **Maintainer** of the component).
112@subsection occt_contribution_workflow_2_5 Code review
114 The **Reviewer** analyzes the proposed solution for applicability in accordance with OCCT Code reviewing rules and examines all changes in the sources to detect obvious and possible errors, misprints, conformity to coding style.
116 * If Reviewer detects some problems, he can either:
117 * Fix these issues and provide new solution, reassigning the issue (in **RESOLVED** state) to the **Developer**, who then becomes a **Reviewer**.
118 Possible disagreements should be resolved through discussion, which is done normally within issue notes (or on the OCCT developer’s forum if necessary).
119 * 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.
120 * If Reviewer does not detect any problems, he changes status to **REVIEWED**.
122@subsection occt_contribution_workflow_2_6 Testing
124 The issues that are in **REVIEWED** state are subject of certification (non-regression) testing.
125 The issue is assigned to OCC **Tester** when he starts processing it.
126 The results of tests are checked by the **Tester**:
127 * 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 problem. The **Developer** should produce a new solution.
128 * If the **Tester** does not detect build problems or regressions, he changes the status to **TESTED** for further integration.
130@subsection occt_contribution_workflow_2_7 Integration of a solution
132 Before integration into the master branch of the repository the **Integrator** checks the following conditions:
133 * the change has been reviewed;
134 * the change has been tested without regressions (or with regressions treated properly);
135 * the test case has been created for this issue (when applicable), and the change has been rechecked on this test case;
136 * "Additional information and documentation updates" field is filled by the developer;
137 * the change does not conflict with other changes integrated previously.
139 If the result of check is successful the Integrator integrates solution
140 into the master branch of the repository. Each change is integrated into the master branch
141 as a single commit without preserving the history of changes made in the branch
142 (by rebase, squashing all intermediate commits), however, preserving the author when possible.
143 This is done to have the master branch history plain and clean.
144 The following picture illustrates the process:
146@image html OCCT_ContributionWorkflow_V3_image002.jpg "Integration of several branches"
147@image latex OCCT_ContributionWorkflow_V3_image002.jpg "Integration of several branches"
149 The new master branch is tested against possible regressions that might appear due to interference between separate changes. When the tests are Ok, the new master is pushed to the official repository
150 and the original branches are removed from it.
151 The issue status is set then to **VERIFIED** and is assigned to the **Reporter** so that he could check the fix as-integrated.
153@subsection occt_contribution_workflow_2_8 Closing a bug
155 The **Bugmaster** closes the issue after regular OCCT Release provided that the issue status is **VERIFIED** and that issue was really solved in that release, by rechecking the corresponding test case. The final issue state is **CLOSED**.
157@subsection occt_contribution_workflow_2_9 Reopening a bug
159 If a regression is detected, the **Bugmaster** may reopen and reassign the **CLOSED** issue to the appropriate developer with comprehensive comments about the reason of reopening. The issue then becomes **ASSIGNED** again.
161@section occt_contribution_workflow_3 Appendix
163@subsection occt_contribution_workflow_3_1 Issue attributes
165@subsubsection occt_contribution_workflow_3_1_1 Severity
167 Severity shows at which extent the issue affects the product.
168 The list of used severities is given in the table below in the descending order.
170 | Severity | Description | Weight for Bug Score |
171 | :---------- | :------------------------------------------------ | :------------------: |
172 | crash | Crash of the application or OS, loss of data | 5 |
173 | 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. | 4 |
174 | 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. | 3 |
175 | minor | Incorrect behavior of a function corresponding to the description in software requirements specification. Insufficient performance of a function. | 2 |
176 | tweak | Ergonomic inconvenience, need of light updates. | 1 |
177 | text | Inconsistence of program code to the Coding Standard. Errors in source text (e.g. unnecessary variable declarations, missing comments, grammatical errors in user manuals). | 1 |
178 | trivial | Cosmetic bugs. | 1 |
179 | feature | Bug fix, new feature, improvement that requires workload estimation and validation. | 1 |
180 | integration request | Requested integration of an existing feature into the product. | 0 |
181 | Just a question | A question to be processed, without need of any changes in the product. | 0 |
183@subsubsection occt_contribution_workflow_3_1_2 Statuses of issues
185 The bug statuses that can be applied to the issues are listed in the table below.
187 | Status | Description |
188 | :------------------- | :----------------------------------------- |
189 | New | New just registered issue. Testing case should be created by Reporter. |
190 | Feedback | The issue requires more information; the original posters should pay attention. |
191 | Assigned | Assigned to a developer. |
192 | Resolved + a resolution | The issue has been fixed, and now is waiting for revision. |
193 |Revised + a resolution | The issue has been revised, and now is waiting for testing. |
194 | 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. |
195 | Verified | The fix has been integrated into the master of the corresponding repository |
196 | Closed | The fix has been integrated to the master. The corresponding test case has been executed successfully. The issue is no longer reproduced. |
198@subsubsection occt_contribution_workflow_3_1_3 Resolutions
200 **Resolution** is set when the bug is resolved. "Reopen" resolution is added automatically when the bug is reopened.
202 | Resolution | Description |
203 |:--------------------- | :--------------------------------------------------------------------------- |
204 | Open | The issue is being processed. |
205 | Fixed | The issue has been successfully fixed. |
206 | Reopened | The bug has been reopened because of insufficient fix or regression. |
207 | | Unable to reproduceThe bug is not reproduced. |
208 | Not fixable | The bug cannot be fixed because it is a bug of third party software, or because it requires more workload than it can be allowed. |
209 | Duplicate | The bug for the same issue already exists in the tracker. |
210 | Not a bug | It is a normal behavior in accordance with the specification of the product |
211 | No change required | The issue didn’t require any change of the product, such as a question issue |
212 | Suspended | This resolution is set for Acknowledged status only. It means that the issue is waiting for fix until a special administrative decision is taken (e.g. a budget is not yet set in accordance with the contract) |
213 | Documentation updated | The issue was a normal behavior of the product, but the actions of the user were wrong. The specification and the user manual have been updated to reflect this issue. |
214 | Won’t fix | An administrative/contractual decision has been taken to not fix the bug |
216@subsection occt_contribution_workflow_3_2 Update and evolution of documentation
218 The documentation on Open CASCADE Technology currently exists in three forms:
220 * OCCT Technical Documentation generated automatically with Doxygen tool on the basis of comments in CDL or HXX files.
221 * User’s Reference Documentation on OCCT packages and Products supplied in the form of PDF User’s guides
222 * OCCT Release Documentation supplied in the form of Release Notes with each release.
224 It is strictly required to properly report the improvements and changes introduced in OCCT in all three forms of Documentation.
226@subsubsection occt_contribution_workflow_3_2_1 Maintenance of CDL files
228 Every developer providing a contribution to the source code of OCC
229 should make a relevant change in the corresponding header file, including CDL.
231 Making the appropriate comments is mandatory in the following cases:
233 * Development of a new package / class / method / enumeration;
234 * Modification of an existing package / class / method / enumeration that changes its behavior;
235 * Modification / new development impacts at other packages / classes / methods / enumerations, the documentation which of should be modified correspondingly.
237 The only case when the comments may be not required is introducing
238 a modification that does not change the existing behavior in any noticeable way
239 or brings the behavior in accordance with the existing description.
241 CDL description must be in good English, containing as much relevant
242 information and as clear as possible. If the developer is unable to properly formulate
243 his ideas in English or suspects that his description can be misunderstood,
244 he should address to the Documentation Engineer for language assistance.
245 Such action is completely subject to the discretion of the developer; however,
246 the Documentation Engineer can require that the developer should provide a relevant
247 technical documentation and reopen a bug until all documentation satisfies the requirements above.
249@subsubsection occt_contribution_workflow_3_2_2 Maintenance of the User’s Reference Documentation
251 The User’s Reference Documentation is distributed among a number of User’s Guides,
252 each describing a certain module of OCCT.
253 The User's Guides do not cover the entire functionality of OCCT;
254 however, they describe most widely used and important packages.
256 In most aspects the User's Guides present the information that is contained in CDL descriptions for methods, classes, etc., only from a different point of view. Thus, it is required that any developer who implements a new or modifies an existing package / class / method / enumeration and adds a description of new development or changes in the corresponding CDL file should also check if this class package / class / method / enumeration or the package / class, to which the added class / method belongs is already described in the documentation and update the User’s Reference Documentation correspondingly.
2583.2.3. Preparation of the Release Documentation
260 Before changing the bug Status to RESOLVED, the developer should provide a description of the implemented work using the "Additional information and documentation updates" field of Mantis bugtracker.
262 This description is used for the Release Documentation and has the following purposes:
264 * to inform the OCCT users about the main features and improvements implemented in the platform in the release;
265 * to give a complete and useable list of changes introduced into the OCCT since the latest version.
267 The changes should be described from the user’s viewpoint so that the text
268 could be comprehensible even for beginners having a very vague idea about OCCT.
269 If the developer is unable to properly formulate his ideas in English or suspects
270 that his description can be misunderstood, he should address to the Documentation Engineer
271 for language assistance. Such action is completely subject to the discretion of the developer;
272 however, the Documentation Engineer can require that the developer
273 should provide a relevant technical documentation and reopen a bug
274 until all documentation satisfies the requirements.
276 **Note**, that it is required to single out the changes in the OCCT behavior as compared to the previous versions and especially the changes to be considered when porting from the previous version of OCCT.
278For example:
279* If global macros XXX() was used in the code of your application, revise it for direct use of the argument stream object.
280* You might need to revise the code related to text display in 3d viewer to take into account new approach of using system fonts via XXX library.
282 The **Documentation Engineer** is responsible for preparation of the version Release Notes
283 and update of the User’s Guides. If the **Documentation Engineer** considers that the description currently provided by the **Developer** is somehow inadequate or unsatisfactory he can demand the **Developer** to rewrite the documentation with the **Documentation Engineer’s** assistance.