Files
centurion_erp/.github/ISSUE_TEMPLATE/new_model.md

3.9 KiB

name, about, title, type, labels
name about title type labels
New Database Model Use when creating a new database model. New Model - <model table name> Task task::feature, triage, type::task

📝 Details

🚧 Tasks

  • 🆕 Model Created

  • 🛠️ Migrations added

  • ♻️ Serializer Created

  • 🔄 ViewSet Created

  • 🔗 URL Route Added

  • 🏷️ Model tag added to app/core/lib/slash_commands/linked_model.CommandLinkedModel.get_model() function

    • 📘 Tag updated in the docs
    • tag added to app/core/lib/slash_commands/linked_model.CommandLinkedModel.get_model()
    • ⚒️ Migration Ticket Linked Item item_type choices update

Note

Ensure that when creating the tag the following is adhered to:

  • Two words are not to contain a space char, \s. It is to be replaced with an underscore _
  • As much as practical, keep the tag as close to the model name as possible
  • 📝 New History model created

  • 📓 New Notes model created

    • 🆕 Model Created
    • 🛠️ Migrations added
    • Add app_label to KB Models app/assistance/models/model_knowledge_base_article.all_models().model_apps
    • (Notes not used/required) - Add model_name to KB Models app/assistance/models/model_knowledge_base_article.all_models().excluded_models
    • 🧪 Unit tested
    • 🧪 Functional tested
  • Admin Documentation added/updated if applicable

  • Developer Documentation added/updated if applicable

  • User Documentation added/updated


🧪 Tests

  • Unit Tests
    • API Render (fields)
    • Model
    • ViewSet
  • Function Test
    • History API Render (fields)
    • History Entries
    • API Metadata
    • API Permissions
    • Model
    • Serializer
    • ViewSet

Requirements

A Requirement is a must have. In addition will also be tested.

  • Functional Requirements

  • Non-Functional Requirements