Bug Triaging Guidelines: Difference between revisions
Jump to navigation
Jump to search
(Issue categories) |
(status) |
||
| Line 1: | Line 1: | ||
= Category = | = Category = | ||
The Category field refers to the code component that contains, or is suspected to contain the defect. | The Category field refers to the code component that contains, or is suspected to contain the defect. | ||
If there happens to be an overlap between categories, always choose the most specific category. | If there happens to be an overlap between categories, always choose the most specific category. | ||
| Line 84: | Line 84: | ||
| World Model | | World Model | ||
| Related to the management of world state. | | Related to the management of world state. | ||
|} | |||
= Status = | |||
{| class="wikitable sortable" border="1" | |||
!Category | |||
!Description | |||
|- | |||
| New | |||
| Unconfirmed issue | |||
|- | |||
| Confirmed | |||
| Claims in the issue have been verified by an independent person. | |||
|- | |||
| Resolved | |||
| A developer has fixed the issue locally, but the fix is not included in our main repository (yet). Or the fix is in a new version of a third party dependency, but we can not enforce that OpenMW is built with said version. | |||
|- | |||
| In Progress | |||
| Partially resolved. In most cases it is preferred to split up the unresolved parts into another issue. | |||
|- | |||
| Closed | |||
| The fix is now available in the main repository. The 'version' field will indicate the first version to include this fix. If the issue was a recent regression on the master branch, and not present in any release, the version field shall be left empty. | |||
|- | |||
| Rejected | |||
| The issue was invalid, for example: | |||
* Not our problem ( [[Morrowind_Data_File_Bugs|data file bug]], invalid configuration ) | |||
* Duplicate of another issue which should be linked under 'Related issues' | |||
* Intended behavior | |||
* No reasonable fix could be identified due to constraints outside of our control | |||
Always give an explanation for why the issue is being rejected. | |||
|} | |} | ||
Revision as of 19:47, 17 September 2017
Category
The Category field refers to the code component that contains, or is suspected to contain the defect.
If there happens to be an overlap between categories, always choose the most specific category.
| Category | Description |
|---|---|
| AI | AI related issues. |
| Animation | Issues related to the playback of animations in models. An animation is a keyframe track used to control a visual component of the model. |
| Code Maintenance | Issues related to the quality of the codebase, not a defect in its functionality. Code Maintenance issues should be filed under the tracker 'Task'. |
| Configuration | Issues related to the configuration component that reads the openmw.cfg containing basic start-up configuration for the engine. Not for the user settings in settings.cfg. |
| Dialogue | Issues related to Morrowind dialogue system. |
| Editor | Issues only affecting our editor program, OpenMW-CS. |
| ESM format | Issues related to the parsing of ESM/ESP game file format. |
| ESS-import | Issues related to decoding the ESS savegame format used by the original engine, and its conversion into OpenMW's savegame format, as implemented in 'openmw-essimporter'. |
| Game Mechanics | Related to game mechanics formulae and behavior. |
| General | Not fitting in any other category. |
| GUI | Issues related to the implementation of our GUI. |
| Input | Related to input management and/or control bindings. |
| Launcher | Issues only affecting the game launcher, openmw-launcher. |
| External Dependencies (MyGUI, SDL, OpenSceneGraph) | Issues that originate in the source code of these dependencies and can (or should) only be fixed by changing said upstream source code. Not for issues that can be resolved by using these dependencies in different way. |
| NIF Format | Issues related to the parsing of .nif (NetImmerse) model format, or its conversion into an OpenMW/OSG scene graph. |
| Packaging | Not a defect in the actual source code, but in the compilation and packaging of said code into an end-user product. If possible, put the respective packager as the 'Assignee', or send them a forum PM, because they tend to not follow the tracker very closely.
Windows: Ace, MacOS: corristo, Linux generic: k1ll, Linux Debian/Ubuntu: psi29a Should be filed under the tracker 'Task'. |
| Physics | Related to collision detection or the movement controller. |
| Rendering | Related to 3D rendering. |
| Save/Load | Related to saving/loading of the gameworld. |
| Scripting | Defect in scripting engine or specific script function(s). |
| Sound | Related to sound playback. |
| Tools | |
| Website | Related to openmw.org, bugs.openmw.org or wiki.openmw.org websites. |
| World Model | Related to the management of world state. |
Status
| Category | Description |
|---|---|
| New | Unconfirmed issue |
| Confirmed | Claims in the issue have been verified by an independent person. |
| Resolved | A developer has fixed the issue locally, but the fix is not included in our main repository (yet). Or the fix is in a new version of a third party dependency, but we can not enforce that OpenMW is built with said version. |
| In Progress | Partially resolved. In most cases it is preferred to split up the unresolved parts into another issue. |
| Closed | The fix is now available in the main repository. The 'version' field will indicate the first version to include this fix. If the issue was a recent regression on the master branch, and not present in any release, the version field shall be left empty. |
| Rejected | The issue was invalid, for example:
Always give an explanation for why the issue is being rejected. |