diff --git a/docs/projects/centurion_erp/development/core/ticket.md b/docs/projects/centurion_erp/development/core/ticket.md new file mode 100644 index 00000000..66541583 --- /dev/null +++ b/docs/projects/centurion_erp/development/core/ticket.md @@ -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.<*>.InheritedCases` _(if inheriting from `Contact`)_ Test cases for sub-models + +- `Functional` Test Cases + + - `core.tests.functional.contact.<*>.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. diff --git a/mkdocs.yml b/mkdocs.yml index c7bce158..df61c886 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: