-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Task
Create a DATABASE.md file in the root of the project to document the database schema, including all tables and their columns.
Acceptance Criteria
- A
DATABASE.mdfile exists. - The file documents the
ticketstable. - The file documents the
ticket_participantstable. - Each table's documentation includes a description of its purpose and a breakdown of each column (name, type, constraints, description).
- The file documents the
keywordstable. - The file documents the
keyword_channel. - The file documents the
ticket_panelstable.
Example Template to Use
Table: tickets
Purpose: Stores the primary state and metadata for each customer support ticket channel.
| Column Name | Data Type | Constraints | Description | Example |
|---|---|---|---|---|
id |
SERIAL |
PRIMARY KEY |
Auto-incrementing unique identifier. | 125 |
channel_id |
NUMERIC(20,0) |
NOT NULL |
The Discord ID of the text channel. | 1234... |
status |
INTEGER |
NOT NULL |
The current status of the ticket. | 1 |
(Continue for all columns and tables)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation