docs(development): initial ticket docs

ref: #724 #564 #723
This commit is contained in:
2025-04-16 21:10:59 +09:30
parent eddd2534ea
commit c80a5b5232
2 changed files with 41 additions and 0 deletions

View File

@ -0,0 +1,39 @@
---
title: Ticket
description: Centurion ERP Base Model Ticket development documentation
date: 2025-04-16
template: project.html
about: https://github.com/nofusscomputing/centurion_erp
---
Ticketing is a base model within Centurion ERP. This base provides the core features for all subsequent sub-ticket models. As such extending Centurion ERP with a new ticket type is a simple process. The adding of a ticket type only requires that you extend an existing ticket model containing only the changes for your new ticket type.
## Core Features
- ...
## History
Ticketing does not use the standard history model of Centurion ERP. History for a ticket is kept in the form of action comments. As each change to a ticket occurs, an action comment is created denoting the from and to in relation to a change.
## Model
When creating your sub-model, do not re-define any field that is already specified within the model you are inheriting from. This is however, with the exception of the code docs specifying otherwise.
## Testing
As with any other object within Centurion, the addition of a feature requires it be tested. The following Test Suites are available:
- `Unit` Test Cases
- `core.tests.unit.contact.<*>.<Inherited class name>InheritedCases` _(if inheriting from `Contact`)_ Test cases for sub-models
- `Functional` Test Cases
- `core.tests.functional.contact.<*>.<Inherited class name>InheritedCases` _(if inheriting from `Contact`)_ Test cases for sub-models
The above listed test cases cover **all** tests for objects that are inherited from the base class. To complete the tests, you will need to add test cases for the differences your model introduces.

View File

@ -147,6 +147,8 @@ nav:
- projects/centurion_erp/development/testing.md
- projects/centurion_erp/development/core/ticket.md
- projects/centurion_erp/development/views.md
- User: